Class VkPipelineExecutablePropertiesKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class VkPipelineExecutablePropertiesKHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure describing a pipeline executable.
    Description

    The stages field may be zero or it may contain one or more bits describing the stages principally used to compile this pipeline. Not all implementations have a 1:1 mapping between shader stages and pipeline executables and some implementations may reduce a given shader stage to fixed function hardware programming such that no executable is available. No guarantees are provided about the mapping between shader stages and pipeline executables and stages should be considered a best effort hint. Because the application cannot rely on the stages field to provide an exact description, name and description provide a human readable name and description which more accurately describes the given pipeline executable.

    Valid Usage (Implicit)
    See Also

    GetPipelineExecutablePropertiesKHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • stages – a bitmask of VkShaderStageFlagBits indicating which shader stages (if any) were principally used as inputs to compile this pipeline executable.
    • name[VK_MAX_DESCRIPTION_SIZE] – a short human readable name for this executable.
    • description[VK_MAX_DESCRIPTION_SIZE] – a human readable description for this executable.
    • subgroupSize – the subgroup size with which this executable is dispatched.

    Layout

    
     struct VkPipelineExecutablePropertiesKHR {
         VkStructureType sType;
         void * pNext;
         VkShaderStageFlags stages;
         char name[VK_MAX_DESCRIPTION_SIZE];
         char description[VK_MAX_DESCRIPTION_SIZE];
         uint32_t subgroupSize;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, STAGES, NAME, DESCRIPTION, SUBGROUPSIZE

        The struct member offsets.
    • Constructor Detail

      • VkPipelineExecutablePropertiesKHR

        public VkPipelineExecutablePropertiesKHR​(java.nio.ByteBuffer container)
        Creates a VkPipelineExecutablePropertiesKHR 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 Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • stages

        public int stages()
        Returns the value of the stages field.
      • name

        public java.nio.ByteBuffer name()
        Returns a ByteBuffer view of the name field.
      • nameString

        public java.lang.String nameString()
        Decodes the null-terminated string stored in the name field.
      • description

        public java.nio.ByteBuffer description()
        Returns a ByteBuffer view of the description field.
      • descriptionString

        public java.lang.String descriptionString()
        Decodes the null-terminated string stored in the description field.
      • subgroupSize

        public int subgroupSize()
        Returns the value of the subgroupSize field.
      • malloc

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

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

        public static VkPipelineExecutablePropertiesKHR create​(long address)
        Returns a new VkPipelineExecutablePropertiesKHR instance for the specified memory address.
      • mallocStack

        public static VkPipelineExecutablePropertiesKHR mallocStack()
        Returns a new VkPipelineExecutablePropertiesKHR instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkPipelineExecutablePropertiesKHR callocStack()
        Returns a new VkPipelineExecutablePropertiesKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static VkPipelineExecutablePropertiesKHR mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkPipelineExecutablePropertiesKHR instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkPipelineExecutablePropertiesKHR callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkPipelineExecutablePropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        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().
      • nstages

        public static int nstages​(long struct)
        Unsafe version of stages().
      • nname

        public static java.nio.ByteBuffer nname​(long struct)
        Unsafe version of name().
      • nnameString

        public static java.lang.String nnameString​(long struct)
        Unsafe version of nameString().
      • ndescription

        public static java.nio.ByteBuffer ndescription​(long struct)
        Unsafe version of description().
      • ndescriptionString

        public static java.lang.String ndescriptionString​(long struct)
        Unsafe version of descriptionString().
      • nsubgroupSize

        public static int nsubgroupSize​(long struct)
        Unsafe version of subgroupSize().
      • 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.