Class VkOpticalFlowExecuteInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkOpticalFlowExecuteInfoNV>

org.lwjgl.vulkan.VkOpticalFlowExecuteInfoNV

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkOpticalFlowExecuteInfoNV
extends Struct<VkOpticalFlowExecuteInfoNV>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkOpticalFlowExecuteInfoNV.Buffer	An array of VkOpticalFlowExecuteInfoNV structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PREGIONS	The struct member offsets.
static final int	REGIONCOUNT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkOpticalFlowExecuteInfoNV(ByteBuffer container)	Creates a VkOpticalFlowExecuteInfoNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkOpticalFlowExecuteInfoNV	calloc()	Returns a new VkOpticalFlowExecuteInfoNV instance allocated with memCalloc.
static VkOpticalFlowExecuteInfoNV.Buffer	calloc(int capacity)	Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with memCalloc.
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.
static VkOpticalFlowExecuteInfoNV	calloc(MemoryStack stack)	Returns a new VkOpticalFlowExecuteInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpticalFlowExecuteInfoNV	create()	Returns a new VkOpticalFlowExecuteInfoNV instance allocated with BufferUtils.
static VkOpticalFlowExecuteInfoNV.Buffer	create(int capacity)	Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with BufferUtils.
static VkOpticalFlowExecuteInfoNV	create(long address)	Returns a new VkOpticalFlowExecuteInfoNV instance for the specified memory address.
static VkOpticalFlowExecuteInfoNV.Buffer	create(long address, int capacity)	Create a VkOpticalFlowExecuteInfoNV.Buffer instance at the specified memory.
static @Nullable VkOpticalFlowExecuteInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkOpticalFlowExecuteInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()
VkOpticalFlowExecuteInfoNV	flags(int value)	Sets the specified value to the flags field.
static VkOpticalFlowExecuteInfoNV	malloc()	Returns a new VkOpticalFlowExecuteInfoNV instance allocated with memAlloc.
static VkOpticalFlowExecuteInfoNV.Buffer	malloc(int capacity)	Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with memAlloc.
static VkOpticalFlowExecuteInfoNV.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkOpticalFlowExecuteInfoNV	malloc(MemoryStack stack)	Returns a new VkOpticalFlowExecuteInfoNV instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable VkRect2D.Buffer	npRegions(long struct)	Unsafe version of pRegions().
static void	npRegions(long struct, @Nullable VkRect2D.Buffer value)	Unsafe version of pRegions.
static int	nregionCount(long struct)	Unsafe version of regionCount().
static void	nregionCount(long struct, int value)	Sets the specified value to the regionCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkOpticalFlowExecuteInfoNV	pNext(long value)	Sets the specified value to the pNext field.
@Nullable VkRect2D.Buffer	pRegions()
VkOpticalFlowExecuteInfoNV	pRegions(@Nullable VkRect2D.Buffer value)	Sets the address of the specified VkRect2D.Buffer to the pRegions field.
int	regionCount()
VkOpticalFlowExecuteInfoNV	set(int sType, long pNext, int flags, @Nullable VkRect2D.Buffer pRegions)	Initializes this struct with the specified values.
VkOpticalFlowExecuteInfoNV	set(VkOpticalFlowExecuteInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkOpticalFlowExecuteInfoNV	sType(int value)	Sets the specified value to the sType field.
VkOpticalFlowExecuteInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

REGIONCOUNT

public static final int REGIONCOUNT

The struct member offsets.

PREGIONS

public static final int PREGIONS

The struct member offsets.

Constructor Details

VkOpticalFlowExecuteInfoNV

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkOpticalFlowExecuteInfoNV>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

flags

@NativeType("VkOpticalFlowExecuteFlagsNV")
public int flags()

Returns:

the value of the flags field.

regionCount

@NativeType("uint32_t")
public int regionCount()

Returns:

the value of the regionCount field.

pRegions

@NativeType("VkRect2D const *")
public @Nullable VkRect2D.Buffer pRegions()

Returns:

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

sType

public VkOpticalFlowExecuteInfoNV sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkOpticalFlowExecuteInfoNV sType$Default()

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV value to the sType field.

pNext

public VkOpticalFlowExecuteInfoNV pNext(@NativeType("void *")
 long value)

Sets the specified value to the pNext field.

flags

public VkOpticalFlowExecuteInfoNV flags(@NativeType("VkOpticalFlowExecuteFlagsNV")
 int value)

Sets the specified value to the flags field.

pRegions

public VkOpticalFlowExecuteInfoNV pRegions(@NativeType("VkRect2D const *")
 @Nullable VkRect2D.Buffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkOpticalFlowExecuteInfoNV set(VkOpticalFlowExecuteInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkOpticalFlowExecuteInfoNV malloc()

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

calloc

public static VkOpticalFlowExecuteInfoNV calloc()

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

create

public static VkOpticalFlowExecuteInfoNV create()

Returns a new VkOpticalFlowExecuteInfoNV instance allocated with BufferUtils.

create

public static VkOpticalFlowExecuteInfoNV create(long address)

Returns a new VkOpticalFlowExecuteInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkOpticalFlowExecuteInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkOpticalFlowExecuteInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkOpticalFlowExecuteInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkOpticalFlowExecuteInfoNV.Buffer create(int capacity)

Returns a new VkOpticalFlowExecuteInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkOpticalFlowExecuteInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkOpticalFlowExecuteInfoNV malloc(MemoryStack stack)

Returns a new VkOpticalFlowExecuteInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nregionCount

public static int nregionCount(long struct)

Unsafe version of regionCount().

npRegions

public static @Nullable VkRect2D.Buffer npRegions(long struct)

Unsafe version of pRegions().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nregionCount

public static void nregionCount(long struct,
 int value)

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

npRegions

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

Unsafe version of pRegions.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate