Package org.lwjgl.vulkan

Class VkPipelineExecutableInternalRepresentationKHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkPipelineExecutableInternalRepresentationKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure describing the textual form of a pipeline executable internal representation.
    Description

    If pData is NULL, then the size, in bytes, of the internal representation data is returned in dataSize. Otherwise, dataSize must be the size of the buffer, in bytes, pointed to by pData and on return dataSize is overwritten with the number of bytes of data actually written to pData including any trailing null character. If dataSize is less than the size, in bytes, of the internal representation data, at most dataSize bytes of data will be written to pData and vkGetPipelineExecutableInternalRepresentationsKHR will return INCOMPLETE. If isText is TRUE and pData is not NULL and dataSize is not zero, the last byte written to pData will be a null character.

    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR
    • pNext must be NULL
    • name must be a null-terminated UTF-8 string whose length is less than or equal to VK_MAX_DESCRIPTION_SIZE
    • description must be a null-terminated UTF-8 string whose length is less than or equal to VK_MAX_DESCRIPTION_SIZE
    • If dataSize is not 0, and pData is not NULL, pData must be a valid pointer to an array of dataSize bytes
    See Also

    GetPipelineExecutableInternalRepresentationsKHR

    Member documentation

    • sType – the type of this structure.
    • pNext – NULL or a pointer to an extension-specific structure.
    • name[VK_MAX_DESCRIPTION_SIZE] – a short human readable name for this internal representation.
    • description[VK_MAX_DESCRIPTION_SIZE] – a human readable description for this internal representation.
    • isText – specifies whether the returned data is text or opaque data. If isText is TRUE then the data returned in pData is text and is guaranteed to be a null-terminated UTF-8 string.
    • dataSize – an integer related to the size, in bytes, of the internal representation data, as described below.
    • pData – either NULL or a pointer to an block of data into which the implementation will write the textual form of the internal representation.

    Layout

    
 struct VkPipelineExecutableInternalRepresentationKHR {
     VkStructureType sType;
     void * pNext;
     char name[VK_MAX_DESCRIPTION_SIZE];
     char description[VK_MAX_DESCRIPTION_SIZE];
     VkBool32 isText;
     size_t dataSize;
     void * pData;
 }