Package org.lwjgl.vulkan
Class VkPipelineExecutablePropertiesKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineExecutablePropertiesKHR>
org.lwjgl.vulkan.VkPipelineExecutablePropertiesKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineExecutablePropertiesKHR
extends org.lwjgl.system.Struct<VkPipelineExecutablePropertiesKHR>
implements org.lwjgl.system.NativeResource
Structure describing a pipeline executable.
Description
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 pipeline executable is available. No guarantees are provided about the mapping between shader stages and pipeline executables and stages should be considered a best effort hint. Because the application cannot rely on the stages field to provide an exact description, name and description provide a human readable name and description which more accurately describes the given pipeline executable.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHRpNextmust beNULL
See Also
GetPipelineExecutablePropertiesKHR
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 ClassesModifier and TypeClassDescriptionstatic classAn array ofVkPipelineExecutablePropertiesKHRstructs.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 size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.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
ConstructorsConstructorDescriptionVkPipelineExecutablePropertiesKHR(ByteBuffer container) Creates aVkPipelineExecutablePropertiesKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutablePropertiesKHRinstance 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 newVkPipelineExecutablePropertiesKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineExecutablePropertiesKHRinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineExecutablePropertiesKHR.Bufferinstance at the specified memory.static @Nullable VkPipelineExecutablePropertiesKHRcreateSafe(long address) static @Nullable VkPipelineExecutablePropertiesKHR.BuffercreateSafe(long address, int capacity) an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this pipeline executable.an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this pipeline executable.malloc()Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutablePropertiesKHRinstance 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 pipeline executable.an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this pipeline executable.static ByteBufferndescription(long struct) Unsafe version ofdescription().static StringndescriptionString(long struct) Unsafe version ofdescriptionString().static ByteBuffernname(long struct) Unsafe version ofname().static StringnnameString(long struct) Unsafe version ofnameString().static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnstages(long struct) Unsafe version ofstages().static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intnsubgroupSize(long struct) Unsafe version ofsubgroupSize().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()intstages()a bitmask of zero or moreVkShaderStageFlagBitsindicating which shader stages (if any) were principally used as inputs to compile this pipeline executable.intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHRvalue to thesType()field.intthe subgroup size with which this pipeline executable is dispatched.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. -
STAGES
public static final int STAGESThe struct member offsets. -
NAME
public static final int NAMEThe struct member offsets. -
DESCRIPTION
public static final int DESCRIPTIONThe struct member offsets. -
SUBGROUPSIZE
public static final int SUBGROUPSIZEThe struct member offsets.
-
-
Constructor Details
-
VkPipelineExecutablePropertiesKHR
Creates aVkPipelineExecutablePropertiesKHRinstance 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<VkPipelineExecutablePropertiesKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
stages
public int stages()a bitmask of zero or moreVkShaderStageFlagBitsindicating which shader stages (if any) were principally used as inputs to compile this pipeline executable. -
name
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this pipeline executable. -
nameString
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this pipeline executable. -
description
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this pipeline executable. -
descriptionString
an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this pipeline executable. -
subgroupSize
public int subgroupSize()the subgroup size with which this pipeline executable is dispatched. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withBufferUtils. -
create
Returns a newVkPipelineExecutablePropertiesKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineExecutablePropertiesKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkPipelineExecutablePropertiesKHR.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 VkPipelineExecutablePropertiesKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkPipelineExecutablePropertiesKHR callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkPipelineExecutablePropertiesKHR.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 VkPipelineExecutablePropertiesKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineExecutablePropertiesKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineExecutablePropertiesKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineExecutablePropertiesKHR.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(). -
nstages
public static int nstages(long struct) Unsafe version ofstages(). -
nname
Unsafe version ofname(). -
nnameString
Unsafe version ofnameString(). -
ndescription
Unsafe version ofdescription(). -
ndescriptionString
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.
-