Package org.lwjgl.vulkan

Class VkVideoFormatPropertiesKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkVideoFormatPropertiesKHR>
org.lwjgl.vulkan.VkVideoFormatPropertiesKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkVideoFormatPropertiesKHR extends org.lwjgl.system.Struct<VkVideoFormatPropertiesKHR> implements org.lwjgl.system.NativeResource
Structure enumerating the video image formats.
Valid Usage (Implicit)
See Also

VkComponentMapping, GetPhysicalDeviceVideoFormatPropertiesKHR

Layout


 struct VkVideoFormatPropertiesKHR {
     VkStructureType sType();
     void * pNext();
     VkFormat format();
     VkComponentMapping componentMapping();
     VkImageCreateFlags imageCreateFlags();
     VkImageType imageType();
     VkImageTiling imageTiling();
     VkImageUsageFlags imageUsageFlags();
 }

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

    • FORMAT

      public static final int FORMAT
      The struct member offsets.

    • COMPONENTMAPPING

      public static final int COMPONENTMAPPING
      The struct member offsets.

    • IMAGECREATEFLAGS

      public static final int IMAGECREATEFLAGS
      The struct member offsets.

    • IMAGETYPE

      public static final int IMAGETYPE
      The struct member offsets.

    • IMAGETILING

      public static final int IMAGETILING
      The struct member offsets.

    • IMAGEUSAGEFLAGS

      public static final int IMAGEUSAGEFLAGS
      The struct member offsets.

  • Constructor Details

    • VkVideoFormatPropertiesKHR

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

    • sType

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

    • pNext

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

    • format

      public int format()
      a VkFormat that specifies the format that can be used with the specified video profiles and image usages.

    • componentMapping

      public VkComponentMapping componentMapping()
      defines the color channel order used for the format. format along with componentMapping describe how the color channels are ordered when producing video decoder output or are expected to be ordered in video encoder input, when applicable. If the format reported does not require component swizzling then all members of componentMapping will be set to COMPONENT_SWIZZLE_IDENTITY.

    • imageCreateFlags

      public int imageCreateFlags()
      a bitmask of VkImageCreateFlagBits specifying the supported image creation flags for the format.

    • imageType

      public int imageType()
      a VkImageType that specifies the image type the format can be used with.

    • imageTiling

      public int imageTiling()
      a VkImageTiling that specifies the image tiling the format can be used with.

    • imageUsageFlags

      public int imageUsageFlags()
      a bitmask of VkImageUsageFlagBits specifying the supported image usage flags for the format.

    • sType

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

    • sType$Default

      public VkVideoFormatPropertiesKHR sType$Default()
      Sets the STRUCTURE_TYPE_VIDEO_FORMAT_PROPERTIES_KHR value to the sType() field.

    • pNext

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

    • set

      public VkVideoFormatPropertiesKHR set(int sType, long pNext)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nformat

      public static int nformat(long struct)
      Unsafe version of format().

    • ncomponentMapping

      public static VkComponentMapping ncomponentMapping(long struct)
      Unsafe version of componentMapping().

    • nimageCreateFlags

      public static int nimageCreateFlags(long struct)
      Unsafe version of imageCreateFlags().

    • nimageType

      public static int nimageType(long struct)
      Unsafe version of imageType().

    • nimageTiling

      public static int nimageTiling(long struct)
      Unsafe version of imageTiling().

    • nimageUsageFlags

      public static int nimageUsageFlags(long struct)
      Unsafe version of imageUsageFlags().

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