Package org.lwjgl.vulkan

Class VkOpticalFlowExecuteInfoNV

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkOpticalFlowExecuteInfoNV>
org.lwjgl.vulkan.VkOpticalFlowExecuteInfoNV
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkOpticalFlowExecuteInfoNV extends org.lwjgl.system.Struct<VkOpticalFlowExecuteInfoNV> implements org.lwjgl.system.NativeResource
Structure specifying parameters of an optical flow vector calculation.
Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_OPTICAL_FLOW_EXECUTE_INFO_NV
  • pNext must be NULL
  • flags must be a valid combination of VkOpticalFlowExecuteFlagBitsNV values
  • If regionCount is not 0, pRegions must be a valid pointer to an array of regionCount VkRect2D structures
See Also

VkRect2D, CmdOpticalFlowExecuteNV

Layout


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

  • 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()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkOpticalFlowExecuteInfoNV>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • flags

      public int flags()
      are the VkOpticalFlowExecuteFlagsNV used for this command.

    • regionCount

      public int regionCount()
      the number of regions of interest specified in pRegions.

    • pRegions

      public @Nullable VkRect2D.Buffer pRegions()
      a pointer to regionCount VkRect2D regions of interest.

    • sType

      public VkOpticalFlowExecuteInfoNV sType(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(long value)
      Sets the specified value to the pNext() field.

    • flags

      public VkOpticalFlowExecuteInfoNV flags(int value)
      Sets the specified value to the flags() field.

    • pRegions

      public VkOpticalFlowExecuteInfoNV pRegions(@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(org.lwjgl.system.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(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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