Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkOpticalFlowSessionCreatePrivateDataInfoNV

extends Struct<VkOpticalFlowSessionCreatePrivateDataInfoNV>
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 for NV internal use only.
Valid Usage (Implicit)

Layout


struct VkOpticalFlowSessionCreatePrivateDataInfoNV {
    VkStructureType sType;
    void * pNext;
    uint32_t id;
    uint32_t size;
    void const * pPrivateData;
}

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
ID

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PPRIVATEDATA

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkOpticalFlowSessionCreatePrivateDataInfoNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkOpticalFlowSessionCreatePrivateDataInfoNV
calloc()

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance allocated with memCalloc.

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

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkOpticalFlowSessionCreatePrivateDataInfoNV
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 VkOpticalFlowSessionCreatePrivateDataInfoNV
create()

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance allocated with BufferUtils.

public static VkOpticalFlowSessionCreatePrivateDataInfoNV
create(long address)

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance for the specified memory address.

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

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer instance allocated with BufferUtils.

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

Create a VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer instance at the specified memory.

public static VkOpticalFlowSessionCreatePrivateDataInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
id()

an identifier for data which is passed at a memory location specified in VkOpticalFlowSessionCreatePrivateDataInfoNV::pPrivateData.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
id(int value)

Sets the specified value to the id field.

public static VkOpticalFlowSessionCreatePrivateDataInfoNV
malloc()

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance allocated with memAlloc.

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

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer instance allocated with memAlloc.

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

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance allocated on the specified MemoryStack.

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

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

public static int
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, int value)

Unsafe version of id.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
npPrivateData(long struct)

Unsafe version of pPrivateData.

public static void
npPrivateData(long struct, long value)

Unsafe version of pPrivateData.

public static int
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, int value)

Unsafe version of size.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
pNext(long value)

Sets the specified value to the pNext field.

public long
pPrivateData()

a pointer to NV internal data.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
pPrivateData(long value)

Sets the specified value to the pPrivateData field.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
set(int sType, long pNext, int id, int size, long pPrivateData)

Initializes this struct with the specified values.

public VkOpticalFlowSessionCreatePrivateDataInfoNV

Returns:

this struct
set
(VkOpticalFlowSessionCreatePrivateDataInfoNV
the source struct
src
)

Copies the specified struct data to this struct.

public int
size()

the size of data in bytes which is passed at a memory location specified in VkOpticalFlowSessionCreatePrivateDataInfoNV::pPrivateData.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
size(int value)

Sets the specified value to the size field.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
sType(int value)

Sets the specified value to the sType field.

public VkOpticalFlowSessionCreatePrivateDataInfoNV
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

IDback to summary
public static final int ID

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PPRIVATEDATAback to summary
public static final int PPRIVATEDATA

The struct member offsets.

SIZEback to summary
public static final int SIZE

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.

Constructor Detail

VkOpticalFlowSessionCreatePrivateDataInfoNVback to summary
protected VkOpticalFlowSessionCreatePrivateDataInfoNV(long address, ByteBuffer container)
VkOpticalFlowSessionCreatePrivateDataInfoNVback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV(ByteBuffer container)

Creates a VkOpticalFlowSessionCreatePrivateDataInfoNV 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 VkOpticalFlowSessionCreatePrivateDataInfoNV calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkOpticalFlowSessionCreatePrivateDataInfoNV calloc(MemoryStack stack)

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV 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 VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV.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 VkOpticalFlowSessionCreatePrivateDataInfoNV 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 VkOpticalFlowSessionCreatePrivateDataInfoNV create()

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance allocated with BufferUtils.

createback to summary
public static VkOpticalFlowSessionCreatePrivateDataInfoNV create(long address)

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance for the specified memory address.

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

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkOpticalFlowSessionCreatePrivateDataInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
idback to summary
public int id()

an identifier for data which is passed at a memory location specified in VkOpticalFlowSessionCreatePrivateDataInfoNV::pPrivateData.

Annotations
@NativeType:uint32_t
idback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV id(int value)

Sets the specified value to the id field.

mallocback to summary
public static VkOpticalFlowSessionCreatePrivateDataInfoNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkOpticalFlowSessionCreatePrivateDataInfoNV malloc(MemoryStack stack)

Returns a new VkOpticalFlowSessionCreatePrivateDataInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nidback to summary
public static int nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, int value)

Unsafe version of id.

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.

npPrivateDataback to summary
public static long npPrivateData(long struct)

Unsafe version of pPrivateData.

npPrivateDataback to summary
public static void npPrivateData(long struct, long value)

Unsafe version of pPrivateData.

nsizeback to summary
public static int nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, int value)

Unsafe version of size.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

pPrivateDataback to summary
public long pPrivateData()

a pointer to NV internal data.

Annotations
@NativeType:void const *
pPrivateDataback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV pPrivateData(long value)

Sets the specified value to the pPrivateData field.

setback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV set(int sType, long pNext, int id, int size, long pPrivateData)

Initializes this struct with the specified values.

setback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV set(VkOpticalFlowSessionCreatePrivateDataInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkOpticalFlowSessionCreatePrivateDataInfoNV

the source struct

Returns:VkOpticalFlowSessionCreatePrivateDataInfoNV

this struct

sizeback to summary
public int size()

the size of data in bytes which is passed at a memory location specified in VkOpticalFlowSessionCreatePrivateDataInfoNV::pPrivateData.

Annotations
@NativeType:uint32_t
sizeback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV size(int value)

Sets the specified value to the size field.

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 VkOpticalFlowSessionCreatePrivateDataInfoNV sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_PRIVATE_DATA_INFO_NV value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer

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

An array of VkOpticalFlowSessionCreatePrivateDataInfoNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkOpticalFlowSessionCreatePrivateDataInfoNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkOpticalFlowSessionCreatePrivateDataInfoNV.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 VkOpticalFlowSessionCreatePrivateDataInfoNV
public int

Returns:

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#id field.
id
()

public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
id(int value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#id field.

public long

Returns:

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

public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#pNext field.

public long
public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
pPrivateData(long value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#pPrivateData field.

protected VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
public int

Returns:

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#size field.
size
()

public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
size(int value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#size field.

public int

Returns:

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

public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
sType(int value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#sType field.

public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkOpticalFlowSessionCreatePrivateDataInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkOpticalFlowSessionCreatePrivateDataInfoNV.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 VkOpticalFlowSessionCreatePrivateDataInfoNV#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 VkOpticalFlowSessionCreatePrivateDataInfoNV getElementFactory()

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

Annotations
@Override
idback to summary
public int id()
Returns:int

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#id field.

Annotations
@NativeType:uint32_t
idback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer id(int value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#id field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#pNext field.

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

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#pNext field.

pPrivateDataback to summary
public long pPrivateData()
Returns:long

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#pPrivateData field.

Annotations
@NativeType:void const *
pPrivateDataback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer pPrivateData(long value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#pPrivateData field.

selfback to summary
protected VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer self()

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

Annotations
@Override
sizeback to summary
public int size()
Returns:int

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#size field.

Annotations
@NativeType:uint32_t
sizeback to summary
public VkOpticalFlowSessionCreatePrivateDataInfoNV.Buffer size(int value)

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#size field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkOpticalFlowSessionCreatePrivateDataInfoNV#sType field.

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

Sets the specified value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#sType field.

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

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_PRIVATE_DATA_INFO_NV value to the VkOpticalFlowSessionCreatePrivateDataInfoNV#sType field.