Class VkPipelineExecutableInternalRepresentationKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.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.NativeResourceStructure describing the textual form of a pipeline executable internal representation.Description
If
pDataisNULL, then the size, in bytes, of the internal representation data is returned indataSize. Otherwise,dataSizemust be the size of the buffer, in bytes, pointed to bypDataand on returndataSizeis overwritten with the number of bytes of data actually written topDataincluding any trailing null character. IfdataSizeis less than the size, in bytes, of the internal representation’s data, at mostdataSizebytes of data will be written topData, andINCOMPLETEwill be returned instead ofSUCCESS, to indicate that not all the available representation was returned.If
isTextisTRUEandpDatais notNULLanddataSizeis not zero, the last byte written topDatawill be a null character.Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHRpNextmust beNULL
See Also
GetPipelineExecutableInternalRepresentationsKHRLayout
struct VkPipelineExecutableInternalRepresentationKHR { VkStructureTypesType(); void *pNext(); charname()[VK_MAX_DESCRIPTION_SIZE]; chardescription()[VK_MAX_DESCRIPTION_SIZE]; VkBool32isText(); size_tdataSize(); void *pData(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineExecutableInternalRepresentationKHR.BufferAn array ofVkPipelineExecutableInternalRepresentationKHRstructs.
-
Constructor Summary
Constructors Constructor Description VkPipelineExecutableInternalRepresentationKHR(java.nio.ByteBuffer container)Creates aVkPipelineExecutableInternalRepresentationKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkPipelineExecutableInternalRepresentationKHRcalloc()Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemCalloc.static VkPipelineExecutableInternalRepresentationKHR.Buffercalloc(int capacity)Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemCalloc.static VkPipelineExecutableInternalRepresentationKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineExecutableInternalRepresentationKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineExecutableInternalRepresentationKHRcallocStack()Deprecated.static VkPipelineExecutableInternalRepresentationKHR.BuffercallocStack(int capacity)Deprecated.static VkPipelineExecutableInternalRepresentationKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineExecutableInternalRepresentationKHRcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineExecutableInternalRepresentationKHRcreate()Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withBufferUtils.static VkPipelineExecutableInternalRepresentationKHR.Buffercreate(int capacity)Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withBufferUtils.static VkPipelineExecutableInternalRepresentationKHRcreate(long address)Returns a newVkPipelineExecutableInternalRepresentationKHRinstance for the specified memory address.static VkPipelineExecutableInternalRepresentationKHR.Buffercreate(long address, int capacity)Create aVkPipelineExecutableInternalRepresentationKHR.Bufferinstance at the specified memory.static VkPipelineExecutableInternalRepresentationKHRcreateSafe(long address)static VkPipelineExecutableInternalRepresentationKHR.BuffercreateSafe(long address, int capacity)longdataSize()an integer related to the size, in bytes, of the internal representation’s data, as described below.java.nio.ByteBufferdescription()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this internal representation.java.lang.StringdescriptionString()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this internal representation.booleanisText()specifies whether the returned data is text or opaque data.static VkPipelineExecutableInternalRepresentationKHRmalloc()Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemAlloc.static VkPipelineExecutableInternalRepresentationKHR.Buffermalloc(int capacity)Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemAlloc.static VkPipelineExecutableInternalRepresentationKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineExecutableInternalRepresentationKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated on the specifiedMemoryStack.static VkPipelineExecutableInternalRepresentationKHRmallocStack()Deprecated.static VkPipelineExecutableInternalRepresentationKHR.BuffermallocStack(int capacity)Deprecated.static VkPipelineExecutableInternalRepresentationKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineExecutableInternalRepresentationKHRmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.java.nio.ByteBuffername()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this internal representation.java.lang.StringnameString()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this internal representation.static longndataSize(long struct)Unsafe version ofdataSize().static java.nio.ByteBufferndescription(long struct)Unsafe version ofdescription().static java.lang.StringndescriptionString(long struct)Unsafe version ofdescriptionString().static intnisText(long struct)Unsafe version ofisText().static java.nio.ByteBuffernname(long struct)Unsafe version ofname().static java.lang.StringnnameString(long struct)Unsafe version ofnameString().static java.nio.ByteBuffernpData(long struct)Unsafe version ofpData.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.java.nio.ByteBufferpData()eitherNULLor a pointer to a block of data into which the implementation will write the internal representation.longpNext()NULLor a pointer to a structure extending this structure.VkPipelineExecutableInternalRepresentationKHRpNext(long value)Sets the specified value to thepNext()field.VkPipelineExecutableInternalRepresentationKHRset(int sType, long pNext)Initializes this struct with the specified values.VkPipelineExecutableInternalRepresentationKHRset(VkPipelineExecutableInternalRepresentationKHR src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkPipelineExecutableInternalRepresentationKHRsType(int value)Sets the specified value to thesType()field.VkPipelineExecutableInternalRepresentationKHRsType$Default()Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHRvalue to thesType()field.
-
-
-
Constructor Detail
-
VkPipelineExecutableInternalRepresentationKHR
public VkPipelineExecutableInternalRepresentationKHR(java.nio.ByteBuffer container)
Creates aVkPipelineExecutableInternalRepresentationKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
name, nameString
public java.nio.ByteBuffer name() public java.lang.String nameString()
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this internal representation.
-
description, descriptionString
public java.nio.ByteBuffer description() public java.lang.String descriptionString()
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this internal representation.
-
isText
public boolean isText()
specifies whether the returned data is text or opaque data. IfisTextisTRUEthen the data returned inpDatais text and is guaranteed to be a null-terminated UTF-8 string.
-
dataSize
public long dataSize()
an integer related to the size, in bytes, of the internal representation’s data, as described below.
-
pData
@Nullable public java.nio.ByteBuffer pData()
eitherNULLor a pointer to a block of data into which the implementation will write the internal representation.
-
sType
public VkPipelineExecutableInternalRepresentationKHR sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPipelineExecutableInternalRepresentationKHR sType$Default()
Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHRvalue to thesType()field.
-
pNext
public VkPipelineExecutableInternalRepresentationKHR pNext(long value)
Sets the specified value to thepNext()field.
-
set
public VkPipelineExecutableInternalRepresentationKHR set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkPipelineExecutableInternalRepresentationKHR set(VkPipelineExecutableInternalRepresentationKHR src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineExecutableInternalRepresentationKHR malloc()
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineExecutableInternalRepresentationKHR calloc()
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineExecutableInternalRepresentationKHR create()
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withBufferUtils.
-
create
public static VkPipelineExecutableInternalRepresentationKHR create(long address)
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineExecutableInternalRepresentationKHR createSafe(long address)
-
malloc
public static VkPipelineExecutableInternalRepresentationKHR.Buffer malloc(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineExecutableInternalRepresentationKHR.Buffer calloc(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineExecutableInternalRepresentationKHR.Buffer create(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineExecutableInternalRepresentationKHR.Buffer create(long address, int capacity)
Create aVkPipelineExecutableInternalRepresentationKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPipelineExecutableInternalRepresentationKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineExecutableInternalRepresentationKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkPipelineExecutableInternalRepresentationKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineExecutableInternalRepresentationKHR calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineExecutableInternalRepresentationKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkPipelineExecutableInternalRepresentationKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nname
public static java.nio.ByteBuffer nname(long struct)
Unsafe version ofname().
-
nnameString
public static java.lang.String nnameString(long struct)
Unsafe version ofnameString().
-
ndescription
public static java.nio.ByteBuffer ndescription(long struct)
Unsafe version ofdescription().
-
ndescriptionString
public static java.lang.String ndescriptionString(long struct)
Unsafe version ofdescriptionString().
-
nisText
public static int nisText(long struct)
Unsafe version ofisText().
-
ndataSize
public static long ndataSize(long struct)
Unsafe version ofdataSize().
-
npData
@Nullable public static java.nio.ByteBuffer npData(long struct)
Unsafe version ofpData.
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
-