Class VkPipelineExecutableInternalRepresentationKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
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’s data, at most dataSize bytes of data will be written to pData, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available representation was returned.
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)
sTypemust beSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHRpNextmust beNULL
See Also
GetPipelineExecutableInternalRepresentationsKHR
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();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineExecutableInternalRepresentationKHRstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkPipelineExecutableInternalRepresentationKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineExecutableInternalRepresentationKHRinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineExecutableInternalRepresentationKHR.Bufferinstance at the specified memory.static @Nullable VkPipelineExecutableInternalRepresentationKHRcreateSafe(long address) static @Nullable VkPipelineExecutableInternalRepresentationKHR.BuffercreateSafe(long address, int capacity) longdataSize()an integer related to the size, in bytes, of the internal representation’s data, as described below.an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this internal representation.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.malloc()Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.name()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this internal representation.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 ByteBufferndescription(long struct) Unsafe version ofdescription().static StringndescriptionString(long struct) Unsafe version ofdescriptionString().static intnisText(long struct) Unsafe version ofisText().static ByteBuffernname(long struct) Unsafe version ofname().static StringnnameString(long struct) Unsafe version ofnameString().static @Nullable 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.@Nullable 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.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHRvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
NAME
public static final int NAMEThe struct member offsets. -
DESCRIPTION
public static final int DESCRIPTIONThe struct member offsets. -
ISTEXT
public static final int ISTEXTThe struct member offsets. -
DATASIZE
public static final int DATASIZEThe struct member offsets. -
PDATA
public static final int PDATAThe struct member offsets.
-
-
Constructor Details
-
VkPipelineExecutableInternalRepresentationKHR
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkPipelineExecutableInternalRepresentationKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
name
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this internal representation. -
nameString
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this internal representation. -
description
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this internal representation. -
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
eitherNULLor a pointer to a block of data into which the implementation will write the internal representation. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
set
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
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance allocated withBufferUtils. -
create
Returns a newVkPipelineExecutableInternalRepresentationKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineExecutableInternalRepresentationKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
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
public static @Nullable VkPipelineExecutableInternalRepresentationKHR.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
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:
capacity- the buffer capacitystack- the stack from which to allocate
-
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:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nname
Unsafe version ofname(). -
nnameString
Unsafe version ofnameString(). -
ndescription
Unsafe version ofdescription(). -
ndescriptionString
Unsafe version ofdescriptionString(). -
nisText
public static int nisText(long struct) Unsafe version ofisText(). -
ndataSize
public static long ndataSize(long struct) Unsafe version ofdataSize(). -
npData
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.
-