Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkOpticalFlowExecuteInfoNV

extends Struct<VkOpticalFlowExecuteInfoNV>
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 specifying parameters of a optical flow vector calculation.
Valid Usage
Valid Usage (Implicit)
See Also

VkRect2D, CmdOpticalFlowExecuteNV

Layout


struct VkOpticalFlowExecuteInfoNV {
    VkStructureType sType;
    void * pNext;
    VkOpticalFlowExecuteFlagsNV flags;
    uint32_t regionCount;
    VkRect2D const * pRegions;
}

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
FLAGS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
PREGIONS

The struct member offsets.

public static final int
REGIONCOUNT

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
VkOpticalFlowExecuteInfoNV(long address, ByteBuffer container)

public
VkOpticalFlowExecuteInfoNV(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkOpticalFlowExecuteInfoNV
calloc()

Returns a new VkOpticalFlowExecuteInfoNV instance allocated with memCalloc.

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

Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkOpticalFlowExecuteInfoNV instance allocated with BufferUtils.

public static VkOpticalFlowExecuteInfoNV
create(long address)

Returns a new VkOpticalFlowExecuteInfoNV instance for the specified memory address.

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

Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with BufferUtils.

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

Create a VkOpticalFlowExecuteInfoNV.Buffer instance at the specified memory.

public static VkOpticalFlowExecuteInfoNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

are the VkOpticalFlowExecuteFlagsNV used for this command.

public VkOpticalFlowExecuteInfoNV
flags(int value)

Sets the specified value to the flags field.

public static VkOpticalFlowExecuteInfoNV
malloc()

Returns a new VkOpticalFlowExecuteInfoNV instance allocated with memAlloc.

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

Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with memAlloc.

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

Returns a new VkOpticalFlowExecuteInfoNV instance allocated on the specified MemoryStack.

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

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

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static VkRect2D.Buffer
npRegions(long struct)

Unsafe version of pRegions.

public static void
npRegions(long struct, VkRect2D.Buffer value)

Unsafe version of pRegions.

public static int
nregionCount(long struct)

Unsafe version of regionCount.

public static void
nregionCount(long struct, int value)

Sets the specified value to the regionCount field of the specified struct.

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 VkOpticalFlowExecuteInfoNV
pNext(long value)

Sets the specified value to the pNext field.

public VkRect2D.Buffer
pRegions()

a pointer to regionCount VkRect2D regions of interest.

public VkOpticalFlowExecuteInfoNV
pRegions(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pRegions field.

public int
regionCount()

the number of regions of interest specified in pRegions.

public VkOpticalFlowExecuteInfoNV
set(int sType, long pNext, int flags, VkRect2D.Buffer pRegions)

Initializes this struct with the specified values.

public VkOpticalFlowExecuteInfoNV

Returns:

this struct
set
(VkOpticalFlowExecuteInfoNV
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 VkOpticalFlowExecuteInfoNV
sType(int value)

Sets the specified value to the sType field.

public VkOpticalFlowExecuteInfoNV
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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

PREGIONSback to summary
public static final int PREGIONS

The struct member offsets.

REGIONCOUNTback to summary
public static final int REGIONCOUNT

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

VkOpticalFlowExecuteInfoNVback to summary
protected VkOpticalFlowExecuteInfoNV(long address, ByteBuffer container)
VkOpticalFlowExecuteInfoNVback to summary
public VkOpticalFlowExecuteInfoNV(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkOpticalFlowExecuteInfoNV calloc(MemoryStack stack)

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

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

Returns a new VkOpticalFlowExecuteInfoNV instance allocated with BufferUtils.

createback to summary
public static VkOpticalFlowExecuteInfoNV create(long address)

Returns a new VkOpticalFlowExecuteInfoNV instance for the specified memory address.

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

Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkOpticalFlowExecuteInfoNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkOpticalFlowExecuteInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

are the VkOpticalFlowExecuteFlagsNV used for this command.

Annotations
@NativeType:VkOpticalFlowExecuteFlagsNV
flagsback to summary
public VkOpticalFlowExecuteInfoNV flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkOpticalFlowExecuteInfoNV malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkOpticalFlowExecuteInfoNV malloc(MemoryStack stack)

Returns a new VkOpticalFlowExecuteInfoNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

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.

npRegionsback to summary
public static VkRect2D.Buffer npRegions(long struct)

Unsafe version of pRegions.

Annotations
@Nullable
npRegionsback to summary
public static void npRegions(long struct, VkRect2D.Buffer value)

Unsafe version of pRegions.

nregionCountback to summary
public static int nregionCount(long struct)

Unsafe version of regionCount.

nregionCountback to summary
public static void nregionCount(long struct, int value)

Sets the specified value to the regionCount field of the specified struct.

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 VkOpticalFlowExecuteInfoNV pNext(long value)

Sets the specified value to the pNext field.

pRegionsback to summary
public VkRect2D.Buffer pRegions()

a pointer to regionCount VkRect2D regions of interest.

Annotations
@Nullable
@NativeType:VkRect2D const *
pRegionsback to summary
public VkOpticalFlowExecuteInfoNV pRegions(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pRegions field.

regionCountback to summary
public int regionCount()

the number of regions of interest specified in pRegions.

Annotations
@NativeType:uint32_t
setback to summary
public VkOpticalFlowExecuteInfoNV set(int sType, long pNext, int flags, VkRect2D.Buffer pRegions)

Initializes this struct with the specified values.

setback to summary
public VkOpticalFlowExecuteInfoNV set(VkOpticalFlowExecuteInfoNV src)

Copies the specified struct data to this struct.

Parameters
src:VkOpticalFlowExecuteInfoNV

the source struct

Returns:VkOpticalFlowExecuteInfoNV

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_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 VkOpticalFlowExecuteInfoNV.Buffer

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

An array of VkOpticalFlowExecuteInfoNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkOpticalFlowExecuteInfoNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkOpticalFlowExecuteInfoNV#flags field.
flags
()

public VkOpticalFlowExecuteInfoNV.Buffer
flags(int value)

Sets the specified value to the VkOpticalFlowExecuteInfoNV#flags field.

protected VkOpticalFlowExecuteInfoNV
public long

Returns:

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

public VkOpticalFlowExecuteInfoNV.Buffer
pNext(long value)

Sets the specified value to the VkOpticalFlowExecuteInfoNV#pNext field.

public VkRect2D.Buffer

Returns:

a VkRect2D.Buffer view of the struct array pointed to by the VkOpticalFlowExecuteInfoNV#pRegions field.
pRegions
()

public VkOpticalFlowExecuteInfoNV.Buffer
pRegions(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the VkOpticalFlowExecuteInfoNV#pRegions field.

public int

Returns:

the value of the VkOpticalFlowExecuteInfoNV#regionCount field.
regionCount
()

protected VkOpticalFlowExecuteInfoNV.Buffer
public int

Returns:

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

public VkOpticalFlowExecuteInfoNV.Buffer
sType(int value)

Sets the specified value to the VkOpticalFlowExecuteInfoNV#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkOpticalFlowExecuteInfoNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkOpticalFlowExecuteInfoNV.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 VkOpticalFlowExecuteInfoNV#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

flagsback to summary
public int flags()
Returns:int

the value of the VkOpticalFlowExecuteInfoNV#flags field.

Annotations
@NativeType:VkOpticalFlowExecuteFlagsNV
flagsback to summary
public VkOpticalFlowExecuteInfoNV.Buffer flags(int value)

Sets the specified value to the VkOpticalFlowExecuteInfoNV#flags field.

getElementFactoryback to summary
protected VkOpticalFlowExecuteInfoNV getElementFactory()

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

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

the value of the VkOpticalFlowExecuteInfoNV#pNext field.

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

Sets the specified value to the VkOpticalFlowExecuteInfoNV#pNext field.

pRegionsback to summary
public VkRect2D.Buffer pRegions()
Returns:VkRect2D.Buffer

a VkRect2D.Buffer view of the struct array pointed to by the VkOpticalFlowExecuteInfoNV#pRegions field.

Annotations
@Nullable
@NativeType:VkRect2D const *
pRegionsback to summary
public VkOpticalFlowExecuteInfoNV.Buffer pRegions(VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the VkOpticalFlowExecuteInfoNV#pRegions field.

regionCountback to summary
public int regionCount()
Returns:int

the value of the VkOpticalFlowExecuteInfoNV#regionCount field.

Annotations
@NativeType:uint32_t
selfback to summary
protected VkOpticalFlowExecuteInfoNV.Buffer self()

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

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

the value of the VkOpticalFlowExecuteInfoNV#sType field.

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

Sets the specified value to the VkOpticalFlowExecuteInfoNV#sType field.

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

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV value to the VkOpticalFlowExecuteInfoNV#sType field.