Class VkPipelineBinaryCreateInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
When pPipelineCreateInfo is not NULL, an implementation will attempt to retrieve pipeline binary data from an internal cache external to the application if pipelineBinaryInternalCache is TRUE. Applications can use this to determine if a pipeline can be created without compilation. If the implementation fails to create a pipeline binary due to missing an internal cache entry, PIPELINE_BINARY_MISSING_KHR is returned. If creation succeeds, the resulting binary can be used to create a pipeline. PIPELINE_BINARY_MISSING_KHR may be returned for any reason in this situation, even if creating a pipeline binary with the same parameters that succeeded earlier.
If pipelineBinaryPrecompiledInternalCache is TRUE, the implementation may be able to create pipeline binaries even when pPipelineCreateInfo has not been used to create binaries before by the application.
Note
On some platforms, internal pipeline caches may be pre-populated before running the application.
Valid Usage
- If
pipelineis notNULL_HANDLE,pipelinemust have been created withPIPELINE_CREATE_2_CAPTURE_DATA_BIT_KHR - If
pipelineis notNULL_HANDLE,ReleaseCapturedPipelineDataKHRmust not have been called onpipelineprior to this command - If
pipelineBinaryInternalCacheisFALSEpPipelineCreateInfo must beNULL - If
devicewas created withVkDevicePipelineBinaryInternalCacheControlKHR::disableInternalCacheset toTRUE,pPipelineCreateInfomust beNULL - One and only one of
pKeysAndDataInfo,pipeline, orpPipelineCreateInfomust be non-NULL - If
pPipelineCreateInfois notNULL, thepNextchain ofpPipelineCreateInfomust not setVkPipelineBinaryInfoKHR::binaryCountto a value greater than 0
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHRpNextmust beNULL- If
pKeysAndDataInfois notNULL,pKeysAndDataInfomust be a valid pointer to a validVkPipelineBinaryKeysAndDataKHRstructure - If
pipelineis notNULL_HANDLE,pipelinemust be a validVkPipelinehandle - If
pPipelineCreateInfois notNULL,pPipelineCreateInfomust be a valid pointer to a validVkPipelineCreateInfoKHRstructure
See Also
VkPipelineBinaryKeysAndDataKHR, VkPipelineCreateInfoKHR, CreatePipelineBinariesKHR
Layout
struct VkPipelineBinaryCreateInfoKHR {
VkStructureType sType();
void const * pNext();
VkPipelineBinaryKeysAndDataKHR const * pKeysAndDataInfo();
VkPipeline pipeline();
VkPipelineCreateInfoKHR const * pPipelineCreateInfo();
}-
Nested Class Summary
Nested ClassesNested 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 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
ConstructorsConstructorDescriptionVkPipelineBinaryCreateInfoKHR(ByteBuffer container) Creates aVkPipelineBinaryCreateInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkPipelineBinaryCreateInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkPipelineBinaryCreateInfoKHR.Bufferinstance at the specified memory.static @Nullable VkPipelineBinaryCreateInfoKHRcreateSafe(long address) static @Nullable VkPipelineBinaryCreateInfoKHR.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated on the specifiedMemoryStack.static longnpipeline(long struct) Unsafe version ofpipeline().static voidnpipeline(long struct, long value) Unsafe version ofpipeline.static @Nullable VkPipelineBinaryKeysAndDataKHRnpKeysAndDataInfo(long struct) Unsafe version ofpKeysAndDataInfo().static voidnpKeysAndDataInfo(long struct, @Nullable VkPipelineBinaryKeysAndDataKHR value) Unsafe version ofpKeysAndDataInfo.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static @Nullable VkPipelineCreateInfoKHRnpPipelineCreateInfo(long struct) Unsafe version ofpPipelineCreateInfo().static voidnpPipelineCreateInfo(long struct, @Nullable VkPipelineCreateInfoKHR value) Unsafe version ofpPipelineCreateInfo.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpipeline()NULL_HANDLEor aVkPipelinethat contains data to create the pipeline binaries from.pipeline(long value) Sets the specified value to thepipeline()field.@Nullable VkPipelineBinaryKeysAndDataKHRNULLor a pointer to aVkPipelineBinaryKeysAndDataKHRstructure that contains keys and data to create the pipeline binaries from.pKeysAndDataInfo(@Nullable VkPipelineBinaryKeysAndDataKHR value) Sets the address of the specifiedVkPipelineBinaryKeysAndDataKHRto thepKeysAndDataInfo()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.@Nullable VkPipelineCreateInfoKHRNULLor a pointer to aVkPipelineCreateInfoKHRstructure with the pipeline creation info.pPipelineCreateInfo(@Nullable VkPipelineCreateInfoKHR value) Sets the address of the specifiedVkPipelineCreateInfoKHRto thepPipelineCreateInfo()field.set(int sType, long pNext, @Nullable VkPipelineBinaryKeysAndDataKHR pKeysAndDataInfo, long pipeline, @Nullable VkPipelineCreateInfoKHR pPipelineCreateInfo) 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_BINARY_CREATE_INFO_KHRvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.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. -
PKEYSANDDATAINFO
public static final int PKEYSANDDATAINFOThe struct member offsets. -
PIPELINE
public static final int PIPELINEThe struct member offsets. -
PPIPELINECREATEINFO
public static final int PPIPELINECREATEINFOThe struct member offsets.
-
-
Constructor Details
-
VkPipelineBinaryCreateInfoKHR
Creates aVkPipelineBinaryCreateInfoKHRinstance 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<VkPipelineBinaryCreateInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
pKeysAndDataInfo
NULLor a pointer to aVkPipelineBinaryKeysAndDataKHRstructure that contains keys and data to create the pipeline binaries from. -
pipeline
public long pipeline()NULL_HANDLEor aVkPipelinethat contains data to create the pipeline binaries from. -
pPipelineCreateInfo
NULLor a pointer to aVkPipelineCreateInfoKHRstructure with the pipeline creation info. This is used to probe the implementation’s internal cache for pipeline binaries. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_BINARY_CREATE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pKeysAndDataInfo
public VkPipelineBinaryCreateInfoKHR pKeysAndDataInfo(@Nullable VkPipelineBinaryKeysAndDataKHR value) Sets the address of the specifiedVkPipelineBinaryKeysAndDataKHRto thepKeysAndDataInfo()field. -
pipeline
Sets the specified value to thepipeline()field. -
pPipelineCreateInfo
Sets the address of the specifiedVkPipelineCreateInfoKHRto thepPipelineCreateInfo()field. -
set
public VkPipelineBinaryCreateInfoKHR set(int sType, long pNext, @Nullable VkPipelineBinaryKeysAndDataKHR pKeysAndDataInfo, long pipeline, @Nullable VkPipelineCreateInfoKHR pPipelineCreateInfo) 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 newVkPipelineBinaryCreateInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkPipelineBinaryCreateInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkPipelineBinaryCreateInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
malloc
Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkPipelineBinaryCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineBinaryCreateInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineBinaryCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkPipelineBinaryCreateInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkPipelineBinaryCreateInfoKHR.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(). -
npKeysAndDataInfo
Unsafe version ofpKeysAndDataInfo(). -
npipeline
public static long npipeline(long struct) Unsafe version ofpipeline(). -
npPipelineCreateInfo
Unsafe version ofpPipelineCreateInfo(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
npKeysAndDataInfo
Unsafe version ofpKeysAndDataInfo. -
npipeline
public static void npipeline(long struct, long value) Unsafe version ofpipeline. -
npPipelineCreateInfo
Unsafe version ofpPipelineCreateInfo. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-