Package org.lwjgl.vulkan

Class VkOpticalFlowImageFormatPropertiesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkOpticalFlowImageFormatPropertiesNV>

org.lwjgl.vulkan.VkOpticalFlowImageFormatPropertiesNV

All Implemented Interfaces:

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

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

Structure describing properties of an optical flow image format.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_PROPERTIES_NV
• pNext must be NULL

See Also

GetPhysicalDeviceOpticalFlowImageFormatsNV

Layout

 struct VkOpticalFlowImageFormatPropertiesNV {
     VkStructureType sType();
     void const * pNext();
     VkFormat format();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkOpticalFlowImageFormatPropertiesNV.Buffer	An array of VkOpticalFlowImageFormatPropertiesNV 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	FORMAT	The struct member offsets.
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.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkOpticalFlowImageFormatPropertiesNV	calloc()	Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated with memCalloc.
static VkOpticalFlowImageFormatPropertiesNV.Buffer	calloc(int capacity)	Returns a new VkOpticalFlowImageFormatPropertiesNV.Buffer instance allocated with memCalloc.
static VkOpticalFlowImageFormatPropertiesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatPropertiesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpticalFlowImageFormatPropertiesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkOpticalFlowImageFormatPropertiesNV	create()	Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated with BufferUtils.
static VkOpticalFlowImageFormatPropertiesNV.Buffer	create(int capacity)	Returns a new VkOpticalFlowImageFormatPropertiesNV.Buffer instance allocated with BufferUtils.
static VkOpticalFlowImageFormatPropertiesNV	create(long address)	Returns a new VkOpticalFlowImageFormatPropertiesNV instance for the specified memory address.
static VkOpticalFlowImageFormatPropertiesNV.Buffer	create(long address, int capacity)	Create a VkOpticalFlowImageFormatPropertiesNV.Buffer instance at the specified memory.
static @Nullable VkOpticalFlowImageFormatPropertiesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkOpticalFlowImageFormatPropertiesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	format()	a VkFormat that specifies the format that can be used with the specified optical flow image usages.
static VkOpticalFlowImageFormatPropertiesNV	malloc()	Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated with memAlloc.
static VkOpticalFlowImageFormatPropertiesNV.Buffer	malloc(int capacity)	Returns a new VkOpticalFlowImageFormatPropertiesNV.Buffer instance allocated with memAlloc.
static VkOpticalFlowImageFormatPropertiesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatPropertiesNV.Buffer instance allocated on the specified MemoryStack.
static VkOpticalFlowImageFormatPropertiesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated on the specified MemoryStack.
static int	nformat(long struct)	Unsafe version of format().
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkOpticalFlowImageFormatPropertiesNV	pNext(long value)	Sets the specified value to the pNext() field.
VkOpticalFlowImageFormatPropertiesNV	set(int sType, long pNext)	Initializes this struct with the specified values.
VkOpticalFlowImageFormatPropertiesNV	set(VkOpticalFlowImageFormatPropertiesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkOpticalFlowImageFormatPropertiesNV	sType(int value)	Sets the specified value to the sType() field.
VkOpticalFlowImageFormatPropertiesNV	sType$Default()	Sets the STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_PROPERTIES_NV value to the sType() 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.

FORMAT

public static final int FORMAT

The struct member offsets.

Constructor Details

VkOpticalFlowImageFormatPropertiesNV

public VkOpticalFlowImageFormatPropertiesNV(ByteBuffer container)

Creates a VkOpticalFlowImageFormatPropertiesNV 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<VkOpticalFlowImageFormatPropertiesNV>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

format

public int format()

a VkFormat that specifies the format that can be used with the specified optical flow image usages.

sType

public VkOpticalFlowImageFormatPropertiesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkOpticalFlowImageFormatPropertiesNV sType$Default()

Sets the STRUCTURE_TYPE_OPTICAL_FLOW_IMAGE_FORMAT_PROPERTIES_NV value to the sType() field.

pNext

public VkOpticalFlowImageFormatPropertiesNV pNext(long value)

Sets the specified value to the pNext() field.

set

public VkOpticalFlowImageFormatPropertiesNV set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkOpticalFlowImageFormatPropertiesNV set(VkOpticalFlowImageFormatPropertiesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkOpticalFlowImageFormatPropertiesNV malloc()

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

calloc

public static VkOpticalFlowImageFormatPropertiesNV calloc()

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

create

public static VkOpticalFlowImageFormatPropertiesNV create()

Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated with BufferUtils.

create

public static VkOpticalFlowImageFormatPropertiesNV create(long address)

Returns a new VkOpticalFlowImageFormatPropertiesNV instance for the specified memory address.

createSafe

public static @Nullable VkOpticalFlowImageFormatPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkOpticalFlowImageFormatPropertiesNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkOpticalFlowImageFormatPropertiesNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkOpticalFlowImageFormatPropertiesNV.Buffer create(int capacity)

Returns a new VkOpticalFlowImageFormatPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkOpticalFlowImageFormatPropertiesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkOpticalFlowImageFormatPropertiesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nformat

public static int nformat(long struct)

Unsafe version of format().

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.