Package org.lwjgl.vulkan
Class VkOpticalFlowSessionCreateInfoNV
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkOpticalFlowSessionCreateInfoNV>
org.lwjgl.vulkan.VkOpticalFlowSessionCreateInfoNV
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkOpticalFlowSessionCreateInfoNV
extends org.lwjgl.system.Struct<VkOpticalFlowSessionCreateInfoNV>
implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created optical flow session.
Valid Usage
widthmust be greater than or equal toVkPhysicalDeviceOpticalFlowPropertiesNV::minWidthand less than or equal toVkPhysicalDeviceOpticalFlowPropertiesNV::maxWidthheightmust be greater than or equal toVkPhysicalDeviceOpticalFlowPropertiesNV::minHeightand less than or equal toVkPhysicalDeviceOpticalFlowPropertiesNV::maxHeightimageFormatmust be one of the formats returned byGetPhysicalDeviceOpticalFlowImageFormatsNVforOPTICAL_FLOW_USAGE_INPUT_BIT_NVflowVectorFormatmust be one of the formats returned byGetPhysicalDeviceOpticalFlowImageFormatsNVforOPTICAL_FLOW_USAGE_OUTPUT_BIT_NVcostFormatmust be one of the formats returned byGetPhysicalDeviceOpticalFlowImageFormatsNVforOPTICAL_FLOW_USAGE_COST_BIT_NVifOPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NVis set inflagsoutputGridSizemust be exactly one of the bits reported inVkPhysicalDeviceOpticalFlowPropertiesNV::supportedOutputGridSizeshintGridSizemust be exactly one of the bits reported inVkPhysicalDeviceOpticalFlowPropertiesNV::supportedHintGridSizesifOPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NVis set inflagsOPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NVmust not be set inflagsifVkPhysicalDeviceOpticalFlowPropertiesNV::hintSupportedisFALSEOPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NVmust not be set inflagsifVkPhysicalDeviceOpticalFlowPropertiesNV::costSupportedisFALSEOPTICAL_FLOW_SESSION_CREATE_ENABLE_GLOBAL_FLOW_BIT_NVmust not be set inflagsifVkPhysicalDeviceOpticalFlowPropertiesNV::globalFlowSupportedisFALSEOPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NVmust not be set inflagsifVkPhysicalDeviceOpticalFlowPropertiesNV::maxNumRegionsOfInterestis 0OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NVmust not be set inflagsifVkPhysicalDeviceOpticalFlowPropertiesNV::bidirectionalFlowSupportedisFALSE
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_INFO_NVpNextmust beNULLor a pointer to a valid instance ofVkOpticalFlowSessionCreatePrivateDataInfoNV- The
sTypevalue of each struct in thepNextchain must be unique imageFormatmust be a validVkFormatvalueflowVectorFormatmust be a validVkFormatvalue- If
costFormatis not 0,costFormatmust be a validVkFormatvalue outputGridSizemust be a valid combination ofVkOpticalFlowGridSizeFlagBitsNVvaluesoutputGridSizemust not be 0hintGridSizemust be a valid combination ofVkOpticalFlowGridSizeFlagBitsNVvalues- If
performanceLevelis not 0,performanceLevelmust be a validVkOpticalFlowPerformanceLevelNVvalue flagsmust be a valid combination ofVkOpticalFlowSessionCreateFlagBitsNVvalues
See Also
Layout
struct VkOpticalFlowSessionCreateInfoNV {
VkStructureType sType();
void * pNext();
uint32_t width();
uint32_t height();
VkFormat imageFormat();
VkFormat flowVectorFormat();
VkFormat costFormat();
VkOpticalFlowGridSizeFlagsNV outputGridSize();
VkOpticalFlowGridSizeFlagsNV hintGridSize();
VkOpticalFlowPerformanceLevelNV performanceLevel();
VkOpticalFlowSessionCreateFlagsNV flags();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkOpticalFlowSessionCreateInfoNVstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkOpticalFlowSessionCreateInfoNV(ByteBuffer container) Creates aVkOpticalFlowSessionCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.inttheVkFormatof the cost maps to be bound to this optical flow session.costFormat(int value) Sets the specified value to thecostFormat()field.create()Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated withBufferUtils.create(int capacity) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkOpticalFlowSessionCreateInfoNVinstance for the specified memory address.create(long address, int capacity) Create aVkOpticalFlowSessionCreateInfoNV.Bufferinstance at the specified memory.static @Nullable VkOpticalFlowSessionCreateInfoNVcreateSafe(long address) static @Nullable VkOpticalFlowSessionCreateInfoNV.BuffercreateSafe(long address, int capacity) intflags()are theVkOpticalFlowSessionCreateFlagsNVused for this optical flow session.flags(int value) Sets the specified value to theflags()field.inttheVkFormatof the flow vector maps (output or hint) to be bound to this optical flow session.flowVectorFormat(int value) Sets the specified value to theflowVectorFormat()field.intheight()the height in pixels of the input or reference frame to be bound to this optical flow session.height(int value) Sets the specified value to theheight()field.intone exactly bit ofVkOpticalFlowGridSizeFlagsNVspecifying the grid size of the hint flow vector maps to be bound to this optical flow session.hintGridSize(int value) Sets the specified value to thehintGridSize()field.inttheVkFormatof the input and reference frame to be bound to this optical flow session.imageFormat(int value) Sets the specified value to theimageFormat()field.malloc()Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated on the specifiedMemoryStack.static intncostFormat(long struct) Unsafe version ofcostFormat().static voidncostFormat(long struct, int value) Unsafe version ofcostFormat.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intnflowVectorFormat(long struct) Unsafe version offlowVectorFormat().static voidnflowVectorFormat(long struct, int value) Unsafe version offlowVectorFormat.static intnheight(long struct) Unsafe version ofheight().static voidnheight(long struct, int value) Unsafe version ofheight.static intnhintGridSize(long struct) Unsafe version ofhintGridSize().static voidnhintGridSize(long struct, int value) Unsafe version ofhintGridSize.static intnimageFormat(long struct) Unsafe version ofimageFormat().static voidnimageFormat(long struct, int value) Unsafe version ofimageFormat.static intnoutputGridSize(long struct) Unsafe version ofoutputGridSize().static voidnoutputGridSize(long struct, int value) Unsafe version ofoutputGridSize.static intnperformanceLevel(long struct) Unsafe version ofperformanceLevel().static voidnperformanceLevel(long struct, int value) Unsafe version ofperformanceLevel.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnwidth(long struct) Unsafe version ofwidth().static voidnwidth(long struct, int value) Unsafe version ofwidth.intexactly one bit ofVkOpticalFlowGridSizeFlagsNVspecifying the grid size of the output flow and cost maps to be bound to this optical flow session.outputGridSize(int value) Sets the specified value to theoutputGridSize()field.inttheVkOpticalFlowPerformanceLevelNVused for this optical flow session.performanceLevel(int value) Sets the specified value to theperformanceLevel()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkOpticalFlowSessionCreatePrivateDataInfoNVvalue to thepNextchain.set(int sType, long pNext, int width, int height, int imageFormat, int flowVectorFormat, int costFormat, int outputGridSize, int hintGridSize, int performanceLevel, int flags) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_INFO_NVvalue to thesType()field.intwidth()the width in pixels of the input or reference frame to be bound to this optical flow session.width(int value) Sets the specified value to thewidth()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
WIDTH
public static final int WIDTHThe struct member offsets. -
HEIGHT
public static final int HEIGHTThe struct member offsets. -
IMAGEFORMAT
public static final int IMAGEFORMATThe struct member offsets. -
FLOWVECTORFORMAT
public static final int FLOWVECTORFORMATThe struct member offsets. -
COSTFORMAT
public static final int COSTFORMATThe struct member offsets. -
OUTPUTGRIDSIZE
public static final int OUTPUTGRIDSIZEThe struct member offsets. -
HINTGRIDSIZE
public static final int HINTGRIDSIZEThe struct member offsets. -
PERFORMANCELEVEL
public static final int PERFORMANCELEVELThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets.
-
-
Constructor Details
-
VkOpticalFlowSessionCreateInfoNV
Creates aVkOpticalFlowSessionCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkOpticalFlowSessionCreateInfoNV>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
width
public int width()the width in pixels of the input or reference frame to be bound to this optical flow session. -
height
public int height()the height in pixels of the input or reference frame to be bound to this optical flow session. -
imageFormat
public int imageFormat()theVkFormatof the input and reference frame to be bound to this optical flow session. -
flowVectorFormat
public int flowVectorFormat()theVkFormatof the flow vector maps (output or hint) to be bound to this optical flow session. -
costFormat
public int costFormat()theVkFormatof the cost maps to be bound to this optical flow session. -
outputGridSize
public int outputGridSize()exactly one bit ofVkOpticalFlowGridSizeFlagsNVspecifying the grid size of the output flow and cost maps to be bound to this optical flow session. The size of the output flow and cost maps is determined byVkOpticalFlowSessionCreateInfoNV::widthandVkOpticalFlowSessionCreateInfoNV::heightdivided byVkOpticalFlowSessionCreateInfoNV::outputGridSize. -
hintGridSize
public int hintGridSize()one exactly bit ofVkOpticalFlowGridSizeFlagsNVspecifying the grid size of the hint flow vector maps to be bound to this optical flow session. The size of the hint maps is determined byVkOpticalFlowSessionCreateInfoNV::widthandVkOpticalFlowSessionCreateInfoNV::heightdivided byVkOpticalFlowSessionCreateInfoNV::hintGridSize. -
performanceLevel
public int performanceLevel()theVkOpticalFlowPerformanceLevelNVused for this optical flow session. -
flags
public int flags()are theVkOpticalFlowSessionCreateFlagsNVused for this optical flow session. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_OPTICAL_FLOW_SESSION_CREATE_INFO_NVvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkOpticalFlowSessionCreatePrivateDataInfoNVvalue to thepNextchain. -
width
Sets the specified value to thewidth()field. -
height
Sets the specified value to theheight()field. -
imageFormat
Sets the specified value to theimageFormat()field. -
flowVectorFormat
Sets the specified value to theflowVectorFormat()field. -
costFormat
Sets the specified value to thecostFormat()field. -
outputGridSize
Sets the specified value to theoutputGridSize()field. -
hintGridSize
Sets the specified value to thehintGridSize()field. -
performanceLevel
Sets the specified value to theperformanceLevel()field. -
flags
Sets the specified value to theflags()field. -
set
public VkOpticalFlowSessionCreateInfoNV set(int sType, long pNext, int width, int height, int imageFormat, int flowVectorFormat, int costFormat, int outputGridSize, int hintGridSize, int performanceLevel, int flags) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated withBufferUtils. -
create
Returns a newVkOpticalFlowSessionCreateInfoNVinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkOpticalFlowSessionCreateInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkOpticalFlowSessionCreateInfoNV.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkOpticalFlowSessionCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkOpticalFlowSessionCreateInfoNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkOpticalFlowSessionCreateInfoNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkOpticalFlowSessionCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nwidth
public static int nwidth(long struct) Unsafe version ofwidth(). -
nheight
public static int nheight(long struct) Unsafe version ofheight(). -
nimageFormat
public static int nimageFormat(long struct) Unsafe version ofimageFormat(). -
nflowVectorFormat
public static int nflowVectorFormat(long struct) Unsafe version offlowVectorFormat(). -
ncostFormat
public static int ncostFormat(long struct) Unsafe version ofcostFormat(). -
noutputGridSize
public static int noutputGridSize(long struct) Unsafe version ofoutputGridSize(). -
nhintGridSize
public static int nhintGridSize(long struct) Unsafe version ofhintGridSize(). -
nperformanceLevel
public static int nperformanceLevel(long struct) Unsafe version ofperformanceLevel(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nwidth
public static void nwidth(long struct, int value) Unsafe version ofwidth. -
nheight
public static void nheight(long struct, int value) Unsafe version ofheight. -
nimageFormat
public static void nimageFormat(long struct, int value) Unsafe version ofimageFormat. -
nflowVectorFormat
public static void nflowVectorFormat(long struct, int value) Unsafe version offlowVectorFormat. -
ncostFormat
public static void ncostFormat(long struct, int value) Unsafe version ofcostFormat. -
noutputGridSize
public static void noutputGridSize(long struct, int value) Unsafe version ofoutputGridSize. -
nhintGridSize
public static void nhintGridSize(long struct, int value) Unsafe version ofhintGridSize. -
nperformanceLevel
public static void nperformanceLevel(long struct, int value) Unsafe version ofperformanceLevel. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags.
-