Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkOpticalFlowImageFormatInfoNV

extends Struct<VkOpticalFlowImageFormatInfoNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing optical flow image format info.
Valid Usage (Implicit)
See Also

GetPhysicalDeviceOpticalFlowImageFormatsNV

Layout


struct VkOpticalFlowImageFormatInfoNV {
    VkStructureType sType;
    void const * pNext;
    VkOpticalFlowUsageFlagsNV usage;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

public static final int
USAGE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkOpticalFlowImageFormatInfoNV(long address, ByteBuffer container)

public
VkOpticalFlowImageFormatInfoNV(ByteBuffer container)

Creates a VkOpticalFlowImageFormatInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkOpticalFlowImageFormatInfoNV
calloc()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with memCalloc.

public static VkOpticalFlowImageFormatInfoNV.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with memCalloc.

public static VkOpticalFlowImageFormatInfoNV
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkOpticalFlowImageFormatInfoNV.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkOpticalFlowImageFormatInfoNV
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkOpticalFlowImageFormatInfoNV
create()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with BufferUtils.

public static VkOpticalFlowImageFormatInfoNV
create(long address)

Returns a new VkOpticalFlowImageFormatInfoNV instance for the specified memory address.

public static VkOpticalFlowImageFormatInfoNV.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with BufferUtils.

public static VkOpticalFlowImageFormatInfoNV.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkOpticalFlowImageFormatInfoNV.Buffer instance at the specified memory.

public static VkOpticalFlowImageFormatInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkOpticalFlowImageFormatInfoNV.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkOpticalFlowImageFormatInfoNV
malloc()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with memAlloc.

public static VkOpticalFlowImageFormatInfoNV.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with memAlloc.

public static VkOpticalFlowImageFormatInfoNV
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack.

public static VkOpticalFlowImageFormatInfoNV.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated on the specified MemoryStack.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public static int
nusage(long struct)

Unsafe version of usage.

public static void
nusage(long struct, int value)

Unsafe version of usage.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkOpticalFlowImageFormatInfoNV
pNext(long value)

Sets the specified value to the pNext field.

public VkOpticalFlowImageFormatInfoNV
set(int sType, long pNext, int usage)

Initializes this struct with the specified values.

public VkOpticalFlowImageFormatInfoNV

Returns:

this struct
set
(VkOpticalFlowImageFormatInfoNV
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkOpticalFlowImageFormatInfoNV
sType(int value)

Sets the specified value to the sType field.

public VkOpticalFlowImageFormatInfoNV
public int
usage()

a bitmask of VkOpticalFlowUsageFlagBitsNV describing the intended optical flow usage of the image.

public VkOpticalFlowImageFormatInfoNV
usage(int value)

Sets the specified value to the usage field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

USAGEback to summary
public static final int USAGE

The struct member offsets.

Constructor Detail

VkOpticalFlowImageFormatInfoNVback to summary
protected VkOpticalFlowImageFormatInfoNV(long address, ByteBuffer container)
VkOpticalFlowImageFormatInfoNVback to summary
public VkOpticalFlowImageFormatInfoNV(ByteBuffer container)

Creates a VkOpticalFlowImageFormatInfoNV instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

callocback to summary
public static VkOpticalFlowImageFormatInfoNV calloc()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer calloc(int capacity)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkOpticalFlowImageFormatInfoNV calloc(MemoryStack stack)

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkOpticalFlowImageFormatInfoNV create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkOpticalFlowImageFormatInfoNV create()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with BufferUtils.

createback to summary
public static VkOpticalFlowImageFormatInfoNV create(long address)

Returns a new VkOpticalFlowImageFormatInfoNV instance for the specified memory address.

createback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer create(int capacity)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer create(long address, int capacity)

Create a VkOpticalFlowImageFormatInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkOpticalFlowImageFormatInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkOpticalFlowImageFormatInfoNV malloc()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer malloc(int capacity)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkOpticalFlowImageFormatInfoNV malloc(MemoryStack stack)

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkOpticalFlowImageFormatInfoNV.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

nusageback to summary
public static int nusage(long struct)

Unsafe version of usage.

nusageback to summary
public static void nusage(long struct, int value)

Unsafe version of usage.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkOpticalFlowImageFormatInfoNV pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkOpticalFlowImageFormatInfoNV set(int sType, long pNext, int usage)

Initializes this struct with the specified values.

setback to summary
public VkOpticalFlowImageFormatInfoNV set(VkOpticalFlowImageFormatInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkOpticalFlowImageFormatInfoNV

the source struct

Returns:VkOpticalFlowImageFormatInfoNV

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkOpticalFlowImageFormatInfoNV sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkOpticalFlowImageFormatInfoNV sType$Default()

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_INFO_NV value to the sType field.

usageback to summary
public int usage()

a bitmask of VkOpticalFlowUsageFlagBitsNV describing the intended optical flow usage of the image.

Annotations
@NativeType:VkOpticalFlowUsageFlagsNV
usageback to summary
public VkOpticalFlowImageFormatInfoNV usage(int value)

Sets the specified value to the usage field.

org.lwjgl.vulkan back to summary

public Class VkOpticalFlowImageFormatInfoNV.Buffer

extends StructBuffer<VkOpticalFlowImageFormatInfoNV, VkOpticalFlowImageFormatInfoNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkOpticalFlowImageFormatInfoNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkOpticalFlowImageFormatInfoNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkOpticalFlowImageFormatInfoNV.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkOpticalFlowImageFormatInfoNV
public long

Returns:

the value of the VkOpticalFlowImageFormatInfoNV#pNext field.
pNext
()

public VkOpticalFlowImageFormatInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkOpticalFlowImageFormatInfoNV#pNext field.

protected VkOpticalFlowImageFormatInfoNV.Buffer
public int

Returns:

the value of the VkOpticalFlowImageFormatInfoNV#sType field.
sType
()

public VkOpticalFlowImageFormatInfoNV.Buffer
sType(int value)

Sets the specified value to the VkOpticalFlowImageFormatInfoNV#sType field.

public VkOpticalFlowImageFormatInfoNV.Buffer
public int

Returns:

the value of the VkOpticalFlowImageFormatInfoNV#usage field.
usage
()

public VkOpticalFlowImageFormatInfoNV.Buffer
usage(int value)

Sets the specified value to the VkOpticalFlowImageFormatInfoNV#usage field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkOpticalFlowImageFormatInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkOpticalFlowImageFormatInfoNV.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkOpticalFlowImageFormatInfoNV#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkOpticalFlowImageFormatInfoNV getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkOpticalFlowImageFormatInfoNV#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkOpticalFlowImageFormatInfoNV.Buffer pNext(long value)

Sets the specified value to the VkOpticalFlowImageFormatInfoNV#pNext field.

selfback to summary
protected VkOpticalFlowImageFormatInfoNV.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkOpticalFlowImageFormatInfoNV#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkOpticalFlowImageFormatInfoNV.Buffer sType(int value)

Sets the specified value to the VkOpticalFlowImageFormatInfoNV#sType field.

sType$Defaultback to summary
public VkOpticalFlowImageFormatInfoNV.Buffer sType$Default()

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_INFO_NV value to the VkOpticalFlowImageFormatInfoNV#sType field.

usageback to summary
public int usage()
Returns:int

the value of the VkOpticalFlowImageFormatInfoNV#usage field.

Annotations
@NativeType:VkOpticalFlowUsageFlagsNV
usageback to summary
public VkOpticalFlowImageFormatInfoNV.Buffer usage(int value)

Sets the specified value to the VkOpticalFlowImageFormatInfoNV#usage field.