Package org.lwjgl.vulkan
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.NativeResourceStructure 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
stagesshould be considered a best effort hint. Because the application cannot rely on thestagesfield to provide an exact description,nameanddescriptionprovide 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
GetPipelineExecutablePropertiesKHRLayout
struct VkPipelineExecutablePropertiesKHR { VkStructureTypesType(); void *pNext(); VkShaderStageFlagsstages(); charname()[VK_MAX_DESCRIPTION_SIZE]; chardescription()[VK_MAX_DESCRIPTION_SIZE]; uint32_tsubgroupSize(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineExecutablePropertiesKHR.BufferAn array ofVkPipelineExecutablePropertiesKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDESCRIPTION
NAME
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTAGES
STYPE
SUBGROUPSIZEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineExecutablePropertiesKHR(java.nio.ByteBuffer container)Creates aVkPipelineExecutablePropertiesKHRinstance 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 VkPipelineExecutablePropertiesKHRcalloc()Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemCalloc.static VkPipelineExecutablePropertiesKHR.Buffercalloc(int capacity)Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemCalloc.static VkPipelineExecutablePropertiesKHR.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineExecutablePropertiesKHRcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutablePropertiesKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineExecutablePropertiesKHRcallocStack()Deprecated.static VkPipelineExecutablePropertiesKHR.BuffercallocStack(int capacity)Deprecated.static VkPipelineExecutablePropertiesKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineExecutablePropertiesKHRcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineExecutablePropertiesKHRcreate()Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withBufferUtils.static VkPipelineExecutablePropertiesKHR.Buffercreate(int capacity)Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withBufferUtils.static VkPipelineExecutablePropertiesKHRcreate(long address)Returns a newVkPipelineExecutablePropertiesKHRinstance for the specified memory address.static VkPipelineExecutablePropertiesKHR.Buffercreate(long address, int capacity)Create aVkPipelineExecutablePropertiesKHR.Bufferinstance at the specified memory.static VkPipelineExecutablePropertiesKHRcreateSafe(long address)static VkPipelineExecutablePropertiesKHR.BuffercreateSafe(long address, int capacity)java.nio.ByteBufferdescription()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this pipeline executable.java.lang.StringdescriptionString()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a human readable description for this pipeline executable.static VkPipelineExecutablePropertiesKHRmalloc()Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemAlloc.static VkPipelineExecutablePropertiesKHR.Buffermalloc(int capacity)Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemAlloc.static VkPipelineExecutablePropertiesKHR.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineExecutablePropertiesKHRmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineExecutablePropertiesKHRinstance allocated on the specifiedMemoryStack.static VkPipelineExecutablePropertiesKHRmallocStack()Deprecated.static VkPipelineExecutablePropertiesKHR.BuffermallocStack(int capacity)Deprecated.static VkPipelineExecutablePropertiesKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineExecutablePropertiesKHRmallocStack(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 pipeline executable.java.lang.StringnameString()an array ofMAX_DESCRIPTION_SIZEcharcontaining a null-terminated UTF-8 string which is a short human readable name for this pipeline executable.static java.nio.ByteBufferndescription(long struct)Unsafe version ofdescription().static java.lang.StringndescriptionString(long struct)Unsafe version ofdescriptionString().static java.nio.ByteBuffernname(long struct)Unsafe version ofname().static java.lang.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.VkPipelineExecutablePropertiesKHRpNext(long value)Sets the specified value to thepNext()field.VkPipelineExecutablePropertiesKHRset(int sType, long pNext)Initializes this struct with the specified values.VkPipelineExecutablePropertiesKHRset(VkPipelineExecutablePropertiesKHR src)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()the type of this structure.VkPipelineExecutablePropertiesKHRsType(int value)Sets the specified value to thesType()field.VkPipelineExecutablePropertiesKHRsType$Default()Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHRvalue to thesType()field.intsubgroupSize()the subgroup size with which this pipeline executable is dispatched.
-
-
-
Constructor Detail
-
VkPipelineExecutablePropertiesKHR
public VkPipelineExecutablePropertiesKHR(java.nio.ByteBuffer container)
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 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.
-
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, 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 pipeline executable.
-
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 pipeline executable.
-
subgroupSize
public int subgroupSize()
the subgroup size with which this pipeline executable is dispatched.
-
sType
public VkPipelineExecutablePropertiesKHR sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPipelineExecutablePropertiesKHR sType$Default()
Sets theSTRUCTURE_TYPE_PIPELINE_EXECUTABLE_PROPERTIES_KHRvalue 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 newVkPipelineExecutablePropertiesKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineExecutablePropertiesKHR calloc()
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineExecutablePropertiesKHR create()
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated withBufferUtils.
-
create
public static VkPipelineExecutablePropertiesKHR create(long address)
Returns a newVkPipelineExecutablePropertiesKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineExecutablePropertiesKHR createSafe(long address)
-
malloc
public static VkPipelineExecutablePropertiesKHR.Buffer malloc(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineExecutablePropertiesKHR.Buffer calloc(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineExecutablePropertiesKHR.Buffer create(int capacity)
Returns a newVkPipelineExecutablePropertiesKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineExecutablePropertiesKHR.Buffer create(long address, int capacity)
Create aVkPipelineExecutablePropertiesKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPipelineExecutablePropertiesKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPipelineExecutablePropertiesKHR mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineExecutablePropertiesKHR 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 public static VkPipelineExecutablePropertiesKHR.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineExecutablePropertiesKHR.Buffer callocStack(int capacity)
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
public static VkPipelineExecutablePropertiesKHR malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineExecutablePropertiesKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineExecutablePropertiesKHR calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
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.
-
-