Package org.lwjgl.vulkan

Class VkOpticalFlowImageFormatInfoNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkOpticalFlowImageFormatInfoNV>

org.lwjgl.vulkan.VkOpticalFlowImageFormatInfoNV

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkOpticalFlowImageFormatInfoNV
extends org.lwjgl.system.Struct<VkOpticalFlowImageFormatInfoNV>
implements org.lwjgl.system.NativeResource

Structure describing optical flow image format info.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_INFO_NV
• usage must be a valid combination of VkOpticalFlowUsageFlagBitsNV values
• usage must not be 0

See Also

GetPhysicalDeviceOpticalFlowImageFormatsNV

Layout

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkOpticalFlowImageFormatInfoNV	calloc()	Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with memCalloc.
static VkOpticalFlowImageFormatInfoNV.Buffer	calloc(int capacity)	Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with memCalloc.
static VkOpticalFlowImageFormatInfoNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpticalFlowImageFormatInfoNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpticalFlowImageFormatInfoNV	create()	Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with BufferUtils.
static VkOpticalFlowImageFormatInfoNV.Buffer	create(int capacity)	Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with BufferUtils.
static VkOpticalFlowImageFormatInfoNV	create(long address)	Returns a new VkOpticalFlowImageFormatInfoNV instance for the specified memory address.
static VkOpticalFlowImageFormatInfoNV.Buffer	create(long address, int capacity)	Create a VkOpticalFlowImageFormatInfoNV.Buffer instance at the specified memory.
static @Nullable VkOpticalFlowImageFormatInfoNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkOpticalFlowImageFormatInfoNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkOpticalFlowImageFormatInfoNV	malloc()	Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with memAlloc.
static VkOpticalFlowImageFormatInfoNV.Buffer	malloc(int capacity)	Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with memAlloc.
static VkOpticalFlowImageFormatInfoNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated on the specified MemoryStack.
static VkOpticalFlowImageFormatInfoNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nusage(long struct)	Unsafe version of usage().
static void	nusage(long struct, int value)	Unsafe version of usage.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkOpticalFlowImageFormatInfoNV	pNext(long value)	Sets the specified value to the pNext() field.
VkOpticalFlowImageFormatInfoNV	set(int sType, long pNext, int usage)	Initializes this struct with the specified values.
VkOpticalFlowImageFormatInfoNV	set(VkOpticalFlowImageFormatInfoNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkOpticalFlowImageFormatInfoNV	sType(int value)	Sets the specified value to the sType() field.
VkOpticalFlowImageFormatInfoNV	sType$Default()	Sets the STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_INFO_NV value to the sType() field.
int	usage()	a bitmask of VkOpticalFlowUsageFlagBitsNV describing the intended optical flow usage of the image.
VkOpticalFlowImageFormatInfoNV	usage(int value)	Sets the specified value to the usage() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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.

USAGE

public static final int USAGE

The struct member offsets.

Constructor Details

VkOpticalFlowImageFormatInfoNV

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkOpticalFlowImageFormatInfoNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

usage

public int usage()

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

sType

public VkOpticalFlowImageFormatInfoNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkOpticalFlowImageFormatInfoNV sType$Default()

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_INFO_NV value to the sType() field.

pNext

public VkOpticalFlowImageFormatInfoNV pNext(long value)

Sets the specified value to the pNext() field.

usage

public VkOpticalFlowImageFormatInfoNV usage(int value)

Sets the specified value to the usage() field.

set

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

Initializes this struct with the specified values.

set

public VkOpticalFlowImageFormatInfoNV set(VkOpticalFlowImageFormatInfoNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkOpticalFlowImageFormatInfoNV malloc()

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

calloc

public static VkOpticalFlowImageFormatInfoNV calloc()

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

create

public static VkOpticalFlowImageFormatInfoNV create()

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated with BufferUtils.

create

public static VkOpticalFlowImageFormatInfoNV create(long address)

Returns a new VkOpticalFlowImageFormatInfoNV instance for the specified memory address.

createSafe

public static @Nullable VkOpticalFlowImageFormatInfoNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkOpticalFlowImageFormatInfoNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkOpticalFlowImageFormatInfoNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkOpticalFlowImageFormatInfoNV.Buffer create(int capacity)

Returns a new VkOpticalFlowImageFormatInfoNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkOpticalFlowImageFormatInfoNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkOpticalFlowImageFormatInfoNV malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkOpticalFlowImageFormatInfoNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkOpticalFlowImageFormatInfoNV calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkOpticalFlowImageFormatInfoNV.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkOpticalFlowImageFormatInfoNV.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nusage

public static int nusage(long struct)

Unsafe version of usage().

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.

nusage

public static void nusage(long struct,
 int value)

Unsafe version of usage.