Package org.lwjgl.vulkan

Class VkVideoEncodeUsageInfoKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkVideoEncodeUsageInfoKHR>
org.lwjgl.vulkan.VkVideoEncodeUsageInfoKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkVideoEncodeUsageInfoKHR extends org.lwjgl.system.Struct<VkVideoEncodeUsageInfoKHR> implements org.lwjgl.system.NativeResource
Structure specifying video encode usage information.
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_VIDEO_ENCODE_USAGE_INFO_KHR
  • videoUsageHints must be a valid combination of VkVideoEncodeUsageFlagBitsKHR values
  • videoContentHints must be a valid combination of VkVideoEncodeContentFlagBitsKHR values
  • If tuningMode is not 0, tuningMode must be a valid VkVideoEncodeTuningModeKHR value

Layout


 struct VkVideoEncodeUsageInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkVideoEncodeUsageFlagsKHR videoUsageHints();
     VkVideoEncodeContentFlagsKHR videoContentHints();
     VkVideoEncodeTuningModeKHR tuningMode();
 }

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

    • VIDEOUSAGEHINTS

      public static final int VIDEOUSAGEHINTS
      The struct member offsets.

    • VIDEOCONTENTHINTS

      public static final int VIDEOCONTENTHINTS
      The struct member offsets.

    • TUNINGMODE

      public static final int TUNINGMODE
      The struct member offsets.

  • Constructor Details

    • VkVideoEncodeUsageInfoKHR

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

    • sType

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

    • pNext

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

    • videoUsageHints

      public int videoUsageHints()
      a bitmask of VkVideoEncodeUsageFlagBitsKHR specifying hints about the intended use of the video encode profile.

    • videoContentHints

      public int videoContentHints()
      a bitmask of VkVideoEncodeContentFlagBitsKHR specifying hints about the content to be encoded using the video encode profile.

    • tuningMode

      public int tuningMode()
      a VkVideoEncodeTuningModeKHR value specifying the tuning mode to use when encoding with the video profile.

    • sType

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

    • sType$Default

      public VkVideoEncodeUsageInfoKHR sType$Default()
      Sets the STRUCTURE_TYPE_VIDEO_ENCODE_USAGE_INFO_KHR value to the sType() field.

    • pNext

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

    • videoUsageHints

      public VkVideoEncodeUsageInfoKHR videoUsageHints(int value)
      Sets the specified value to the videoUsageHints() field.

    • videoContentHints

      public VkVideoEncodeUsageInfoKHR videoContentHints(int value)
      Sets the specified value to the videoContentHints() field.

    • tuningMode

      public VkVideoEncodeUsageInfoKHR tuningMode(int value)
      Sets the specified value to the tuningMode() field.

    • set

      public VkVideoEncodeUsageInfoKHR set(int sType, long pNext, int videoUsageHints, int videoContentHints, int tuningMode)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nvideoUsageHints

      public static int nvideoUsageHints(long struct)
      Unsafe version of videoUsageHints().

    • nvideoContentHints

      public static int nvideoContentHints(long struct)
      Unsafe version of videoContentHints().

    • ntuningMode

      public static int ntuningMode(long struct)
      Unsafe version of tuningMode().

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

    • nvideoUsageHints

      public static void nvideoUsageHints(long struct, int value)
      Unsafe version of videoUsageHints.

    • nvideoContentHints

      public static void nvideoContentHints(long struct, int value)
      Unsafe version of videoContentHints.

    • ntuningMode

      public static void ntuningMode(long struct, int value)
      Unsafe version of tuningMode.