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.NativeResource
Structure describing the textual form of a pipeline executable internal representation.Description
If
pData
isNULL
, then the size, in bytes, of the internal representation data is returned indataSize
. Otherwise,dataSize
must be the size of the buffer, in bytes, pointed to bypData
and on returndataSize
is overwritten with the number of bytes of data actually written topData
including any trailing null character. IfdataSize
is less than the size, in bytes, of the internal representation data, at mostdataSize
bytes of data will be written topData
andvkGetPipelineExecutableInternalRepresentationsKHR
will returnINCOMPLETE
. IfisText
isTRUE
andpData
is notNULL
anddataSize
is not zero, the last byte written topData
will be a null character.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_INTERNAL_REPRESENTATION_KHR
pNext
must beNULL
name
must be a null-terminated UTF-8 string whose length is less than or equal to VK_MAX_DESCRIPTION_SIZEdescription
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, andpData
is notNULL
,pData
must be a valid pointer to an array ofdataSize
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. IfisText
isTRUE
then the data returned inpData
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
– eitherNULL
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; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineExecutableInternalRepresentationKHR.Buffer
An array ofVkPipelineExecutableInternalRepresentationKHR
structs.
-
Constructor Summary
Constructors Constructor Description VkPipelineExecutableInternalRepresentationKHR(java.nio.ByteBuffer container)
Creates aVkPipelineExecutableInternalRepresentationKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineExecutableInternalRepresentationKHR
calloc()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated withmemCalloc
.static VkPipelineExecutableInternalRepresentationKHR.Buffer
calloc(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated withmemCalloc
.static VkPipelineExecutableInternalRepresentationKHR
callocStack()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineExecutableInternalRepresentationKHR.Buffer
callocStack(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineExecutableInternalRepresentationKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineExecutableInternalRepresentationKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineExecutableInternalRepresentationKHR
create()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated withBufferUtils
.static VkPipelineExecutableInternalRepresentationKHR.Buffer
create(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated withBufferUtils
.static VkPipelineExecutableInternalRepresentationKHR
create(long address)
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance for the specified memory address.static VkPipelineExecutableInternalRepresentationKHR.Buffer
create(long address, int capacity)
Create aVkPipelineExecutableInternalRepresentationKHR.Buffer
instance at the specified memory.static VkPipelineExecutableInternalRepresentationKHR
createSafe(long address)
static VkPipelineExecutableInternalRepresentationKHR.Buffer
createSafe(long address, int capacity)
long
dataSize()
Returns the value of thedataSize
field.VkPipelineExecutableInternalRepresentationKHR
dataSize(long value)
Sets the specified value to thedataSize
field.java.nio.ByteBuffer
description()
Returns aByteBuffer
view of thedescription
field.VkPipelineExecutableInternalRepresentationKHR
description(java.nio.ByteBuffer value)
Copies the specified encoded string to thedescription
field.java.lang.String
descriptionString()
Decodes the null-terminated string stored in thedescription
field.boolean
isText()
Returns the value of theisText
field.VkPipelineExecutableInternalRepresentationKHR
isText(boolean value)
Sets the specified value to theisText
field.static VkPipelineExecutableInternalRepresentationKHR
malloc()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated withmemAlloc
.static VkPipelineExecutableInternalRepresentationKHR.Buffer
malloc(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated withmemAlloc
.static VkPipelineExecutableInternalRepresentationKHR
mallocStack()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the thread-localMemoryStack
.static VkPipelineExecutableInternalRepresentationKHR.Buffer
mallocStack(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineExecutableInternalRepresentationKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineExecutableInternalRepresentationKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the specifiedMemoryStack
.java.nio.ByteBuffer
name()
Returns aByteBuffer
view of thename
field.VkPipelineExecutableInternalRepresentationKHR
name(java.nio.ByteBuffer value)
Copies the specified encoded string to thename
field.java.lang.String
nameString()
Decodes the null-terminated string stored in thename
field.static long
ndataSize(long struct)
Unsafe version ofdataSize()
.static void
ndataSize(long struct, long value)
Sets the specified value to thedataSize
field of the specifiedstruct
.static java.nio.ByteBuffer
ndescription(long struct)
Unsafe version ofdescription()
.static void
ndescription(long struct, java.nio.ByteBuffer value)
Unsafe version ofdescription
.static java.lang.String
ndescriptionString(long struct)
Unsafe version ofdescriptionString()
.static int
nisText(long struct)
Unsafe version ofisText()
.static void
nisText(long struct, int value)
Unsafe version ofisText
.static java.nio.ByteBuffer
nname(long struct)
Unsafe version ofname()
.static void
nname(long struct, java.nio.ByteBuffer value)
Unsafe version ofname
.static java.lang.String
nnameString(long struct)
Unsafe version ofnameString()
.static java.nio.ByteBuffer
npData(long struct)
Unsafe version ofpData
.static void
npData(long struct, java.nio.ByteBuffer value)
Unsafe version ofpData
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.java.nio.ByteBuffer
pData()
Returns aByteBuffer
view of the data pointed to by thepData
field.VkPipelineExecutableInternalRepresentationKHR
pData(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepData
field.long
pNext()
Returns the value of thepNext
field.VkPipelineExecutableInternalRepresentationKHR
pNext(long value)
Sets the specified value to thepNext
field.VkPipelineExecutableInternalRepresentationKHR
set(int sType, long pNext, java.nio.ByteBuffer name, java.nio.ByteBuffer description, boolean isText, long dataSize, java.nio.ByteBuffer pData)
Initializes this struct with the specified values.VkPipelineExecutableInternalRepresentationKHR
set(VkPipelineExecutableInternalRepresentationKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPipelineExecutableInternalRepresentationKHR
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkPipelineExecutableInternalRepresentationKHR
public VkPipelineExecutableInternalRepresentationKHR(java.nio.ByteBuffer container)
Creates aVkPipelineExecutableInternalRepresentationKHR
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
name
public java.nio.ByteBuffer name()
Returns aByteBuffer
view of thename
field.
-
nameString
public java.lang.String nameString()
Decodes the null-terminated string stored in thename
field.
-
description
public java.nio.ByteBuffer description()
Returns aByteBuffer
view of thedescription
field.
-
descriptionString
public java.lang.String descriptionString()
Decodes the null-terminated string stored in thedescription
field.
-
isText
public boolean isText()
Returns the value of theisText
field.
-
dataSize
public long dataSize()
Returns the value of thedataSize
field.
-
pData
@Nullable public java.nio.ByteBuffer pData()
Returns aByteBuffer
view of the data pointed to by thepData
field.
-
sType
public VkPipelineExecutableInternalRepresentationKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineExecutableInternalRepresentationKHR pNext(long value)
Sets the specified value to thepNext
field.
-
name
public VkPipelineExecutableInternalRepresentationKHR name(java.nio.ByteBuffer value)
Copies the specified encoded string to thename
field.
-
description
public VkPipelineExecutableInternalRepresentationKHR description(java.nio.ByteBuffer value)
Copies the specified encoded string to thedescription
field.
-
isText
public VkPipelineExecutableInternalRepresentationKHR isText(boolean value)
Sets the specified value to theisText
field.
-
dataSize
public VkPipelineExecutableInternalRepresentationKHR dataSize(long value)
Sets the specified value to thedataSize
field.
-
pData
public VkPipelineExecutableInternalRepresentationKHR pData(@Nullable java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepData
field.
-
set
public VkPipelineExecutableInternalRepresentationKHR set(int sType, long pNext, java.nio.ByteBuffer name, java.nio.ByteBuffer description, boolean isText, long dataSize, @Nullable java.nio.ByteBuffer pData)
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 newVkPipelineExecutableInternalRepresentationKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineExecutableInternalRepresentationKHR calloc()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineExecutableInternalRepresentationKHR create()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated withBufferUtils
.
-
create
public static VkPipelineExecutableInternalRepresentationKHR create(long address)
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineExecutableInternalRepresentationKHR createSafe(long address)
-
malloc
public static VkPipelineExecutableInternalRepresentationKHR.Buffer malloc(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineExecutableInternalRepresentationKHR.Buffer calloc(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineExecutableInternalRepresentationKHR.Buffer create(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineExecutableInternalRepresentationKHR.Buffer create(long address, int capacity)
Create aVkPipelineExecutableInternalRepresentationKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineExecutableInternalRepresentationKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPipelineExecutableInternalRepresentationKHR mallocStack()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineExecutableInternalRepresentationKHR callocStack()
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineExecutableInternalRepresentationKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineExecutableInternalRepresentationKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineExecutableInternalRepresentationKHR.Buffer mallocStack(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineExecutableInternalRepresentationKHR.Buffer callocStack(int capacity)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineExecutableInternalRepresentationKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineExecutableInternalRepresentationKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutableInternalRepresentationKHR.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
nname
public static void nname(long struct, java.nio.ByteBuffer value)
Unsafe version ofname
.
-
ndescription
public static void ndescription(long struct, java.nio.ByteBuffer value)
Unsafe version ofdescription
.
-
nisText
public static void nisText(long struct, int value)
Unsafe version ofisText
.
-
ndataSize
public static void ndataSize(long struct, long value)
Sets the specified value to thedataSize
field of the specifiedstruct
.
-
npData
public static void npData(long struct, @Nullable java.nio.ByteBuffer value)
Unsafe version ofpData
.
-
-