Package org.lwjgl.vulkan

Class VkPhysicalDeviceOpticalFlowPropertiesNV

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceOpticalFlowPropertiesNV>

org.lwjgl.vulkan.VkPhysicalDeviceOpticalFlowPropertiesNV

All Implemented Interfaces:

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

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

Structure describing properties supported by VK_NV_optical_flow.

Description

If the VkPhysicalDeviceOpticalFlowPropertiesNV structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_OPTICAL_FLOW_PROPERTIES_NV

Layout

 struct VkPhysicalDeviceOpticalFlowPropertiesNV {
     VkStructureType sType();
     void * pNext();
     VkOpticalFlowGridSizeFlagsNV supportedOutputGridSizes();
     VkOpticalFlowGridSizeFlagsNV supportedHintGridSizes();
     VkBool32 hintSupported();
     VkBool32 costSupported();
     VkBool32 bidirectionalFlowSupported();
     VkBool32 globalFlowSupported();
     uint32_t minWidth();
     uint32_t minHeight();
     uint32_t maxWidth();
     uint32_t maxHeight();
     uint32_t maxNumRegionsOfInterest();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	An array of VkPhysicalDeviceOpticalFlowPropertiesNV 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	BIDIRECTIONALFLOWSUPPORTED	The struct member offsets.
static final int	COSTSUPPORTED	The struct member offsets.
static final int	GLOBALFLOWSUPPORTED	The struct member offsets.
static final int	HINTSUPPORTED	The struct member offsets.
static final int	MAXHEIGHT	The struct member offsets.
static final int	MAXNUMREGIONSOFINTEREST	The struct member offsets.
static final int	MAXWIDTH	The struct member offsets.
static final int	MINHEIGHT	The struct member offsets.
static final int	MINWIDTH	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.
static final int	SUPPORTEDHINTGRIDSIZES	The struct member offsets.
static final int	SUPPORTEDOUTPUTGRIDSIZES	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
VkPhysicalDeviceOpticalFlowPropertiesNV(ByteBuffer container)	Creates a VkPhysicalDeviceOpticalFlowPropertiesNV instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
boolean	bidirectionalFlowSupported()	a boolean describing whether bi-directional flow generation is supported in an optical flow session.
static VkPhysicalDeviceOpticalFlowPropertiesNV	calloc()	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated with memCalloc.
static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceOpticalFlowPropertiesNV	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
boolean	costSupported()	a boolean describing whether cost map generation is supported in an optical flow session.
static VkPhysicalDeviceOpticalFlowPropertiesNV	create()	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated with BufferUtils.
static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceOpticalFlowPropertiesNV	create(long address)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance for the specified memory address.
static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceOpticalFlowPropertiesNV	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	globalFlowSupported()	a boolean describing whether global flow vector map generation is supported in an optical flow session.
boolean	hintSupported()	a boolean describing whether using hint flow vector map is supported in an optical flow session.
static VkPhysicalDeviceOpticalFlowPropertiesNV	malloc()	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated with memAlloc.
static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceOpticalFlowPropertiesNV	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated on the specified MemoryStack.
int	maxHeight()	the maximum height in pixels for images used in an optical flow session.
int	maxNumRegionsOfInterest()	the maximum number of regions of interest which can be used in an optical flow session.
int	maxWidth()	the maximum width in pixels for images used in an optical flow session.
int	minHeight()	the minimum height in pixels for images used in an optical flow session.
int	minWidth()	the minimum width in pixels for images used in an optical flow session.
static int	nbidirectionalFlowSupported(long struct)	Unsafe version of bidirectionalFlowSupported().
static int	ncostSupported(long struct)	Unsafe version of costSupported().
static int	nglobalFlowSupported(long struct)	Unsafe version of globalFlowSupported().
static int	nhintSupported(long struct)	Unsafe version of hintSupported().
static int	nmaxHeight(long struct)	Unsafe version of maxHeight().
static int	nmaxNumRegionsOfInterest(long struct)	Unsafe version of maxNumRegionsOfInterest().
static int	nmaxWidth(long struct)	Unsafe version of maxWidth().
static int	nminHeight(long struct)	Unsafe version of minHeight().
static int	nminWidth(long struct)	Unsafe version of minWidth().
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	nsupportedHintGridSizes(long struct)	Unsafe version of supportedHintGridSizes().
static int	nsupportedOutputGridSizes(long struct)	Unsafe version of supportedOutputGridSizes().
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceOpticalFlowPropertiesNV	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceOpticalFlowPropertiesNV	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceOpticalFlowPropertiesNV	set(VkPhysicalDeviceOpticalFlowPropertiesNV src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceOpticalFlowPropertiesNV	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceOpticalFlowPropertiesNV	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_OPTICAL_FLOW_PROPERTIES_NV value to the sType() field.
int	supportedHintGridSizes()	are the supported VkOpticalFlowGridSizeFlagsNV which can be specified in VkOpticalFlowSessionCreateInfoNV::hintGridSize.
int	supportedOutputGridSizes()	are the supported VkOpticalFlowGridSizeFlagsNV which can be specified in VkOpticalFlowSessionCreateInfoNV::outputGridSize.

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.

SUPPORTEDOUTPUTGRIDSIZES

public static final int SUPPORTEDOUTPUTGRIDSIZES

The struct member offsets.

SUPPORTEDHINTGRIDSIZES

public static final int SUPPORTEDHINTGRIDSIZES

The struct member offsets.

HINTSUPPORTED

public static final int HINTSUPPORTED

The struct member offsets.

COSTSUPPORTED

public static final int COSTSUPPORTED

The struct member offsets.

BIDIRECTIONALFLOWSUPPORTED

public static final int BIDIRECTIONALFLOWSUPPORTED

The struct member offsets.

GLOBALFLOWSUPPORTED

public static final int GLOBALFLOWSUPPORTED

The struct member offsets.

MINWIDTH

public static final int MINWIDTH

The struct member offsets.

MINHEIGHT

public static final int MINHEIGHT

The struct member offsets.

MAXWIDTH

public static final int MAXWIDTH

The struct member offsets.

MAXHEIGHT

public static final int MAXHEIGHT

The struct member offsets.

MAXNUMREGIONSOFINTEREST

public static final int MAXNUMREGIONSOFINTEREST

The struct member offsets.

Constructor Details

VkPhysicalDeviceOpticalFlowPropertiesNV

public VkPhysicalDeviceOpticalFlowPropertiesNV(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

supportedOutputGridSizes

public int supportedOutputGridSizes()

are the supported VkOpticalFlowGridSizeFlagsNV which can be specified in VkOpticalFlowSessionCreateInfoNV::outputGridSize.

supportedHintGridSizes

public int supportedHintGridSizes()

are the supported VkOpticalFlowGridSizeFlagsNV which can be specified in VkOpticalFlowSessionCreateInfoNV::hintGridSize.

hintSupported

public boolean hintSupported()

a boolean describing whether using hint flow vector map is supported in an optical flow session.

costSupported

public boolean costSupported()

a boolean describing whether cost map generation is supported in an optical flow session.

bidirectionalFlowSupported

public boolean bidirectionalFlowSupported()

a boolean describing whether bi-directional flow generation is supported in an optical flow session.

globalFlowSupported

public boolean globalFlowSupported()

a boolean describing whether global flow vector map generation is supported in an optical flow session.

minWidth

public int minWidth()

the minimum width in pixels for images used in an optical flow session.

minHeight

public int minHeight()

the minimum height in pixels for images used in an optical flow session.

maxWidth

public int maxWidth()

the maximum width in pixels for images used in an optical flow session.

maxHeight

public int maxHeight()

the maximum height in pixels for images used in an optical flow session.

maxNumRegionsOfInterest

public int maxNumRegionsOfInterest()

the maximum number of regions of interest which can be used in an optical flow session. If this maxNumRegionsOfInterest is 0, regions of interest are not supported in an optical flow session.

sType

public VkPhysicalDeviceOpticalFlowPropertiesNV sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceOpticalFlowPropertiesNV sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_OPTICAL_FLOW_PROPERTIES_NV value to the sType() field.

pNext

public VkPhysicalDeviceOpticalFlowPropertiesNV pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceOpticalFlowPropertiesNV set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceOpticalFlowPropertiesNV set(VkPhysicalDeviceOpticalFlowPropertiesNV src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceOpticalFlowPropertiesNV malloc()

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

calloc

public static VkPhysicalDeviceOpticalFlowPropertiesNV calloc()

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

create

public static VkPhysicalDeviceOpticalFlowPropertiesNV create()

Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated with BufferUtils.

create

public static VkPhysicalDeviceOpticalFlowPropertiesNV create(long address)

Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceOpticalFlowPropertiesNV createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer create(int capacity)

Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceOpticalFlowPropertiesNV.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceOpticalFlowPropertiesNV instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsupportedOutputGridSizes

public static int nsupportedOutputGridSizes(long struct)

Unsafe version of supportedOutputGridSizes().

nsupportedHintGridSizes

public static int nsupportedHintGridSizes(long struct)

Unsafe version of supportedHintGridSizes().

nhintSupported

public static int nhintSupported(long struct)

Unsafe version of hintSupported().

ncostSupported

public static int ncostSupported(long struct)

Unsafe version of costSupported().

nbidirectionalFlowSupported

public static int nbidirectionalFlowSupported(long struct)

Unsafe version of bidirectionalFlowSupported().

nglobalFlowSupported

public static int nglobalFlowSupported(long struct)

Unsafe version of globalFlowSupported().

nminWidth

public static int nminWidth(long struct)

Unsafe version of minWidth().

nminHeight

public static int nminHeight(long struct)

Unsafe version of minHeight().

nmaxWidth

public static int nmaxWidth(long struct)

Unsafe version of maxWidth().

nmaxHeight

public static int nmaxHeight(long struct)

Unsafe version of maxHeight().

nmaxNumRegionsOfInterest

public static int nmaxNumRegionsOfInterest(long struct)

Unsafe version of maxNumRegionsOfInterest().

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.