Class VkRayTracingPipelineInterfaceCreateInfoKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
maxPipelineRayPayloadSize is calculated as the maximum size of the block (in bytes) declared in the RayPayloadKHR or IncomingRayPayloadKHR storage classes. maxPipelineRayHitAttributeSize is calculated as the maximum size of any block (in bytes) declared in the HitAttributeKHR storage class. As variables in these storage classes do not have explicit offsets, the size should be calculated as if each variable has a scalar alignment equal to the largest scalar alignment of any of the block’s members.
Note
There is no explicit upper limit for maxPipelineRayPayloadSize, but in practice it should be kept as small as possible. Similar to invocation local memory, it must be allocated for each shader invocation and for devices which support many simultaneous invocations, this storage can rapidly be exhausted, resulting in failure.
Valid Usage
maxPipelineRayHitAttributeSizemust be less than or equal toVkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayHitAttributeSize
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHRpNextmust beNULL
See Also
VkRayTracingPipelineCreateInfoKHR
Layout
struct VkRayTracingPipelineInterfaceCreateInfoKHR {
VkStructureType sType();
void const * pNext();
uint32_t maxPipelineRayPayloadSize();
uint32_t maxPipelineRayHitAttributeSize();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkRayTracingPipelineInterfaceCreateInfoKHRstructs.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.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionCreates aVkRayTracingPipelineInterfaceCreateInfoKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance for the specified memory address.create(long address, int capacity) Create aVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance at the specified memory.static @Nullable VkRayTracingPipelineInterfaceCreateInfoKHRcreateSafe(long address) static @Nullable VkRayTracingPipelineInterfaceCreateInfoKHR.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated on the specifiedMemoryStack.intthe maximum attribute structure size in bytes used by any shader in the pipeline.maxPipelineRayHitAttributeSize(int value) Sets the specified value to themaxPipelineRayHitAttributeSize()field.intthe maximum payload size in bytes used by any shader in the pipeline.maxPipelineRayPayloadSize(int value) Sets the specified value to themaxPipelineRayPayloadSize()field.static intnmaxPipelineRayHitAttributeSize(long struct) Unsafe version ofmaxPipelineRayHitAttributeSize().static voidnmaxPipelineRayHitAttributeSize(long struct, int value) Unsafe version ofmaxPipelineRayHitAttributeSize.static intnmaxPipelineRayPayloadSize(long struct) Unsafe version ofmaxPipelineRayPayloadSize().static voidnmaxPipelineRayPayloadSize(long struct, int value) Unsafe version ofmaxPipelineRayPayloadSize.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.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, int maxPipelineRayPayloadSize, int maxPipelineRayHitAttributeSize) 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_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHRvalue to thesType()field.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. -
MAXPIPELINERAYPAYLOADSIZE
public static final int MAXPIPELINERAYPAYLOADSIZEThe struct member offsets. -
MAXPIPELINERAYHITATTRIBUTESIZE
public static final int MAXPIPELINERAYHITATTRIBUTESIZEThe struct member offsets.
-
-
Constructor Details
-
VkRayTracingPipelineInterfaceCreateInfoKHR
Creates aVkRayTracingPipelineInterfaceCreateInfoKHRinstance 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<VkRayTracingPipelineInterfaceCreateInfoKHR>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
maxPipelineRayPayloadSize
public int maxPipelineRayPayloadSize()the maximum payload size in bytes used by any shader in the pipeline. -
maxPipelineRayHitAttributeSize
public int maxPipelineRayHitAttributeSize()the maximum attribute structure size in bytes used by any shader in the pipeline. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHRvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
maxPipelineRayPayloadSize
Sets the specified value to themaxPipelineRayPayloadSize()field. -
maxPipelineRayHitAttributeSize
Sets the specified value to themaxPipelineRayHitAttributeSize()field. -
set
public VkRayTracingPipelineInterfaceCreateInfoKHR set(int sType, long pNext, int maxPipelineRayPayloadSize, int maxPipelineRayHitAttributeSize) Initializes this struct with the specified values. -
set
public VkRayTracingPipelineInterfaceCreateInfoKHR set(VkRayTracingPipelineInterfaceCreateInfoKHR src) Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated withBufferUtils. -
create
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkRayTracingPipelineInterfaceCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkRayTracingPipelineInterfaceCreateInfoKHR.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(). -
nmaxPipelineRayPayloadSize
public static int nmaxPipelineRayPayloadSize(long struct) Unsafe version ofmaxPipelineRayPayloadSize(). -
nmaxPipelineRayHitAttributeSize
public static int nmaxPipelineRayHitAttributeSize(long struct) Unsafe version ofmaxPipelineRayHitAttributeSize(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nmaxPipelineRayPayloadSize
public static void nmaxPipelineRayPayloadSize(long struct, int value) Unsafe version ofmaxPipelineRayPayloadSize. -
nmaxPipelineRayHitAttributeSize
public static void nmaxPipelineRayHitAttributeSize(long struct, int value) Unsafe version ofmaxPipelineRayHitAttributeSize.
-