Package org.lwjgl.vulkan

Class VkVideoInlineQueryInfoKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkVideoInlineQueryInfoKHR>
org.lwjgl.vulkan.VkVideoInlineQueryInfoKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkVideoInlineQueryInfoKHR extends org.lwjgl.system.Struct<VkVideoInlineQueryInfoKHR> implements org.lwjgl.system.NativeResource
Structure specifying inline query information for video coding commands.
Description

This structure can be included in the pNext chain of the input parameter structure of video coding commands.

  • In the pNext chain of the pDecodeInfo parameter of the CmdDecodeVideoKHR command to execute a query for each video decode operation issued by the command.
  • In the pNext chain of the pEncodeInfo parameter of the CmdEncodeVideoKHR command to execute a query for each video encode operation issued by the command.
Valid Usage
  • If queryPool is not NULL_HANDLE, then firstQuery must be less than the number of queries in queryPool
  • If queryPool is not NULL_HANDLE, then the sum of firstQuery and queryCount must be less than or equal to the number of queries in queryPool
Valid Usage (Implicit)

Layout


 struct VkVideoInlineQueryInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkQueryPool queryPool();
     uint32_t firstQuery();
     uint32_t queryCount();
 }

  • 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.

    • QUERYPOOL

      public static final int QUERYPOOL
      The struct member offsets.

    • FIRSTQUERY

      public static final int FIRSTQUERY
      The struct member offsets.

    • QUERYCOUNT

      public static final int QUERYCOUNT
      The struct member offsets.

  • Constructor Details

    • VkVideoInlineQueryInfoKHR

      public VkVideoInlineQueryInfoKHR(ByteBuffer container)
      Creates a VkVideoInlineQueryInfoKHR 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<VkVideoInlineQueryInfoKHR>

    • sType

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

    • pNext

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

    • queryPool

      public long queryPool()
      NULL_HANDLE or a valid handle to a VkQueryPool object that will manage the results of the queries.

    • firstQuery

      public int firstQuery()
      the query index within the query pool that will contain the query results for the first video coding operation. The query results of subsequent video coding operations will be contained by subsequent query indices.

    • queryCount

      public int queryCount()
      the number of queries to execute.
      Note

      In practice, if queryPool is not NULL_HANDLE, then queryCount will always have to match the number of video coding operations issued by the video coding command this structure is specified to, meaning that using inline queries in a video coding command will always execute a query for each issued video coding operation.

    • sType

      public VkVideoInlineQueryInfoKHR sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkVideoInlineQueryInfoKHR sType$Default()
      Sets the STRUCTURE_TYPE_VIDEO_INLINE_QUERY_INFO_KHR value to the sType() field.

    • pNext

      public VkVideoInlineQueryInfoKHR pNext(long value)
      Sets the specified value to the pNext() field.

    • queryPool

      public VkVideoInlineQueryInfoKHR queryPool(long value)
      Sets the specified value to the queryPool() field.

    • firstQuery

      public VkVideoInlineQueryInfoKHR firstQuery(int value)
      Sets the specified value to the firstQuery() field.

    • queryCount

      public VkVideoInlineQueryInfoKHR queryCount(int value)
      Sets the specified value to the queryCount() field.

    • set

      public VkVideoInlineQueryInfoKHR set(int sType, long pNext, long queryPool, int firstQuery, int queryCount)
      Initializes this struct with the specified values.

    • set

      public VkVideoInlineQueryInfoKHR set(VkVideoInlineQueryInfoKHR src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkVideoInlineQueryInfoKHR malloc()
      Returns a new VkVideoInlineQueryInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkVideoInlineQueryInfoKHR calloc()
      Returns a new VkVideoInlineQueryInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkVideoInlineQueryInfoKHR create()
      Returns a new VkVideoInlineQueryInfoKHR instance allocated with BufferUtils.

    • create

      public static VkVideoInlineQueryInfoKHR create(long address)
      Returns a new VkVideoInlineQueryInfoKHR instance for the specified memory address.

    • createSafe

      public static @Nullable VkVideoInlineQueryInfoKHR createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkVideoInlineQueryInfoKHR.Buffer malloc(int capacity)
      Returns a new VkVideoInlineQueryInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkVideoInlineQueryInfoKHR.Buffer calloc(int capacity)
      Returns a new VkVideoInlineQueryInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkVideoInlineQueryInfoKHR.Buffer create(int capacity)
      Returns a new VkVideoInlineQueryInfoKHR.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkVideoInlineQueryInfoKHR.Buffer create(long address, int capacity)
      Create a VkVideoInlineQueryInfoKHR.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkVideoInlineQueryInfoKHR.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkVideoInlineQueryInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkVideoInlineQueryInfoKHR instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkVideoInlineQueryInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkVideoInlineQueryInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkVideoInlineQueryInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkVideoInlineQueryInfoKHR.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkVideoInlineQueryInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkVideoInlineQueryInfoKHR.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().

    • nqueryPool

      public static long nqueryPool(long struct)
      Unsafe version of queryPool().

    • nfirstQuery

      public static int nfirstQuery(long struct)
      Unsafe version of firstQuery().

    • nqueryCount

      public static int nqueryCount(long struct)
      Unsafe version of queryCount().

    • 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.

    • nqueryPool

      public static void nqueryPool(long struct, long value)
      Unsafe version of queryPool.

    • nfirstQuery

      public static void nfirstQuery(long struct, int value)
      Unsafe version of firstQuery.

    • nqueryCount

      public static void nqueryCount(long struct, int value)
      Unsafe version of queryCount.