Class VkPipelineExecutablePropertiesKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.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 andstages
should be considered a best effort hint. Because the application cannot rely on thestages
field to provide an exact description,name
anddescription
provide a human readable name and description which more accurately describes the given pipeline executable.Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHR
pNext
must beNULL
See Also
GetPipelineExecutablePropertiesKHR
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.stages
– a bitmask ofVkShaderStageFlagBits
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; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineExecutablePropertiesKHR.Buffer
An array ofVkPipelineExecutablePropertiesKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DESCRIPTION
NAME
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STAGES
STYPE
SUBGROUPSIZEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineExecutablePropertiesKHR(java.nio.ByteBuffer container)
Creates aVkPipelineExecutablePropertiesKHR
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 VkPipelineExecutablePropertiesKHR
calloc()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated withmemCalloc
.static VkPipelineExecutablePropertiesKHR.Buffer
calloc(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated withmemCalloc
.static VkPipelineExecutablePropertiesKHR
callocStack()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineExecutablePropertiesKHR.Buffer
callocStack(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineExecutablePropertiesKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineExecutablePropertiesKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineExecutablePropertiesKHR
create()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated withBufferUtils
.static VkPipelineExecutablePropertiesKHR.Buffer
create(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated withBufferUtils
.static VkPipelineExecutablePropertiesKHR
create(long address)
Returns a newVkPipelineExecutablePropertiesKHR
instance for the specified memory address.static VkPipelineExecutablePropertiesKHR.Buffer
create(long address, int capacity)
Create aVkPipelineExecutablePropertiesKHR.Buffer
instance at the specified memory.static VkPipelineExecutablePropertiesKHR
createSafe(long address)
static VkPipelineExecutablePropertiesKHR.Buffer
createSafe(long address, int capacity)
java.nio.ByteBuffer
description()
Returns aByteBuffer
view of thedescription
field.java.lang.String
descriptionString()
Decodes the null-terminated string stored in thedescription
field.static VkPipelineExecutablePropertiesKHR
malloc()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated withmemAlloc
.static VkPipelineExecutablePropertiesKHR.Buffer
malloc(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated withmemAlloc
.static VkPipelineExecutablePropertiesKHR
mallocStack()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the thread-localMemoryStack
.static VkPipelineExecutablePropertiesKHR.Buffer
mallocStack(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineExecutablePropertiesKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineExecutablePropertiesKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the specifiedMemoryStack
.java.nio.ByteBuffer
name()
Returns aByteBuffer
view of thename
field.java.lang.String
nameString()
Decodes the null-terminated string stored in thename
field.static java.nio.ByteBuffer
ndescription(long struct)
Unsafe version ofdescription()
.static java.lang.String
ndescriptionString(long struct)
Unsafe version ofdescriptionString()
.static java.nio.ByteBuffer
nname(long struct)
Unsafe version ofname()
.static java.lang.String
nnameString(long struct)
Unsafe version ofnameString()
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nstages(long struct)
Unsafe version ofstages()
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nsubgroupSize(long struct)
Unsafe version ofsubgroupSize()
.long
pNext()
Returns the value of thepNext
field.VkPipelineExecutablePropertiesKHR
pNext(long value)
Sets the specified value to thepNext
field.VkPipelineExecutablePropertiesKHR
set(int sType, long pNext)
Initializes this struct with the specified values.VkPipelineExecutablePropertiesKHR
set(VkPipelineExecutablePropertiesKHR src)
Copies the specified struct data to this struct.int
sizeof()
int
stages()
Returns the value of thestages
field.int
sType()
Returns the value of thesType
field.VkPipelineExecutablePropertiesKHR
sType(int value)
Sets the specified value to thesType
field.int
subgroupSize()
Returns the value of thesubgroupSize
field.
-
-
-
Constructor Detail
-
VkPipelineExecutablePropertiesKHR
public VkPipelineExecutablePropertiesKHR(java.nio.ByteBuffer container)
Creates aVkPipelineExecutablePropertiesKHR
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.
-
stages
public int stages()
Returns the value of thestages
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.
-
subgroupSize
public int subgroupSize()
Returns the value of thesubgroupSize
field.
-
sType
public VkPipelineExecutablePropertiesKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineExecutablePropertiesKHR pNext(long value)
Sets the specified value to thepNext
field.
-
set
public VkPipelineExecutablePropertiesKHR set(int sType, long pNext)
Initializes this struct with the specified values.
-
set
public VkPipelineExecutablePropertiesKHR set(VkPipelineExecutablePropertiesKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineExecutablePropertiesKHR malloc()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineExecutablePropertiesKHR calloc()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineExecutablePropertiesKHR create()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated withBufferUtils
.
-
create
public static VkPipelineExecutablePropertiesKHR create(long address)
Returns a newVkPipelineExecutablePropertiesKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineExecutablePropertiesKHR createSafe(long address)
-
malloc
public static VkPipelineExecutablePropertiesKHR.Buffer malloc(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineExecutablePropertiesKHR.Buffer calloc(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineExecutablePropertiesKHR.Buffer create(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineExecutablePropertiesKHR.Buffer create(long address, int capacity)
Create aVkPipelineExecutablePropertiesKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineExecutablePropertiesKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPipelineExecutablePropertiesKHR mallocStack()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineExecutablePropertiesKHR callocStack()
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineExecutablePropertiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineExecutablePropertiesKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineExecutablePropertiesKHR.Buffer mallocStack(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineExecutablePropertiesKHR.Buffer callocStack(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineExecutablePropertiesKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineExecutablePropertiesKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHR.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()
.
-
nstages
public static int nstages(long struct)
Unsafe version ofstages()
.
-
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()
.
-
nsubgroupSize
public static int nsubgroupSize(long struct)
Unsafe version ofsubgroupSize()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
-