Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkRayTracingPipelineInterfaceCreateInfoKHR

extends Struct<VkRayTracingPipelineInterfaceCreateInfoKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying additional interface information when using libraries.
Description

maxPipelineRayPayloadSize is calculated as the maximum number of bytes used by any block declared in the RayPayloadKHR or IncomingRayPayloadKHR storage classes. maxPipelineRayHitAttributeSize is calculated as the maximum number of bytes used by any block 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
Valid Usage (Implicit)
See Also

VkRayTracingPipelineCreateInfoKHR

Layout


struct VkRayTracingPipelineInterfaceCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    uint32_t maxPipelineRayPayloadSize;
    uint32_t maxPipelineRayHitAttributeSize;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MAXPIPELINERAYHITATTRIBUTESIZE

The struct member offsets.

public static final int
MAXPIPELINERAYPAYLOADSIZE

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkRayTracingPipelineInterfaceCreateInfoKHR(ByteBuffer container)

Creates a VkRayTracingPipelineInterfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkRayTracingPipelineInterfaceCreateInfoKHR
calloc()

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with memCalloc.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with memCalloc.

public static VkRayTracingPipelineInterfaceCreateInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkRayTracingPipelineInterfaceCreateInfoKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkRayTracingPipelineInterfaceCreateInfoKHR
create()

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with BufferUtils.

public static VkRayTracingPipelineInterfaceCreateInfoKHR
create(long address)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance for the specified memory address.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance at the specified memory.

public static VkRayTracingPipelineInterfaceCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkRayTracingPipelineInterfaceCreateInfoKHR
malloc()

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with memAlloc.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with memAlloc.

public static VkRayTracingPipelineInterfaceCreateInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated on the specified MemoryStack.

public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.

public int
maxPipelineRayHitAttributeSize()

the maximum attribute structure size in bytes used by any shader in the pipeline.

public VkRayTracingPipelineInterfaceCreateInfoKHR
maxPipelineRayHitAttributeSize(int value)

Sets the specified value to the maxPipelineRayHitAttributeSize field.

public int
maxPipelineRayPayloadSize()

the maximum payload size in bytes used by any shader in the pipeline.

public VkRayTracingPipelineInterfaceCreateInfoKHR
maxPipelineRayPayloadSize(int value)

Sets the specified value to the maxPipelineRayPayloadSize field.

public static int
public static void
nmaxPipelineRayHitAttributeSize(long struct, int value)

Unsafe version of maxPipelineRayHitAttributeSize.

public static int
public static void
nmaxPipelineRayPayloadSize(long struct, int value)

Unsafe version of maxPipelineRayPayloadSize.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkRayTracingPipelineInterfaceCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

public VkRayTracingPipelineInterfaceCreateInfoKHR
set(int sType, long pNext, int maxPipelineRayPayloadSize, int maxPipelineRayHitAttributeSize)

Initializes this struct with the specified values.

public VkRayTracingPipelineInterfaceCreateInfoKHR

Returns:

this struct
set
(VkRayTracingPipelineInterfaceCreateInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkRayTracingPipelineInterfaceCreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkRayTracingPipelineInterfaceCreateInfoKHR
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MAXPIPELINERAYHITATTRIBUTESIZEback to summary
public static final int MAXPIPELINERAYHITATTRIBUTESIZE

The struct member offsets.

MAXPIPELINERAYPAYLOADSIZEback to summary
public static final int MAXPIPELINERAYPAYLOADSIZE

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkRayTracingPipelineInterfaceCreateInfoKHRback to summary
protected VkRayTracingPipelineInterfaceCreateInfoKHR(long address, ByteBuffer container)
VkRayTracingPipelineInterfaceCreateInfoKHRback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR(ByteBuffer container)

Creates a VkRayTracingPipelineInterfaceCreateInfoKHR instance at the current position of the specified ByteBuffer 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

callocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR calloc()

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer calloc(int capacity)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR calloc(MemoryStack stack)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkRayTracingPipelineInterfaceCreateInfoKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR create()

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR create(long address)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance for the specified memory address.

createback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer create(long address, int capacity)

Create a VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR malloc()

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer malloc(int capacity)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

maxPipelineRayHitAttributeSizeback to summary
public int maxPipelineRayHitAttributeSize()

the maximum attribute structure size in bytes used by any shader in the pipeline.

Annotations
@NativeType:uint32_t
maxPipelineRayHitAttributeSizeback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR maxPipelineRayHitAttributeSize(int value)

Sets the specified value to the maxPipelineRayHitAttributeSize field.

maxPipelineRayPayloadSizeback to summary
public int maxPipelineRayPayloadSize()

the maximum payload size in bytes used by any shader in the pipeline.

Annotations
@NativeType:uint32_t
maxPipelineRayPayloadSizeback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR maxPipelineRayPayloadSize(int value)

Sets the specified value to the maxPipelineRayPayloadSize field.

nmaxPipelineRayHitAttributeSizeback to summary
public static int nmaxPipelineRayHitAttributeSize(long struct)

Unsafe version of maxPipelineRayHitAttributeSize.

nmaxPipelineRayHitAttributeSizeback to summary
public static void nmaxPipelineRayHitAttributeSize(long struct, int value)

Unsafe version of maxPipelineRayHitAttributeSize.

nmaxPipelineRayPayloadSizeback to summary
public static int nmaxPipelineRayPayloadSize(long struct)

Unsafe version of maxPipelineRayPayloadSize.

nmaxPipelineRayPayloadSizeback to summary
public static void nmaxPipelineRayPayloadSize(long struct, int value)

Unsafe version of maxPipelineRayPayloadSize.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR set(int sType, long pNext, int maxPipelineRayPayloadSize, int maxPipelineRayHitAttributeSize)

Initializes this struct with the specified values.

setback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR set(VkRayTracingPipelineInterfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkRayTracingPipelineInterfaceCreateInfoKHR

the source struct

Returns:VkRayTracingPipelineInterfaceCreateInfoKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer

extends StructBuffer<VkRayTracingPipelineInterfaceCreateInfoKHR, VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkRayTracingPipelineInterfaceCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkRayTracingPipelineInterfaceCreateInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkRayTracingPipelineInterfaceCreateInfoKHR
public int
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
public int
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
public long

Returns:

the value of the VkRayTracingPipelineInterfaceCreateInfoKHR#pNext field.
pNext
()

public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkRayTracingPipelineInterfaceCreateInfoKHR#pNext field.

protected VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
public int

Returns:

the value of the VkRayTracingPipelineInterfaceCreateInfoKHR#sType field.
sType
()

public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkRayTracingPipelineInterfaceCreateInfoKHR#sType field.

public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkRayTracingPipelineInterfaceCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkRayTracingPipelineInterfaceCreateInfoKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkRayTracingPipelineInterfaceCreateInfoKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
maxPipelineRayHitAttributeSizeback to summary
public int maxPipelineRayHitAttributeSize()
Returns:int

the value of the VkRayTracingPipelineInterfaceCreateInfoKHR#maxPipelineRayHitAttributeSize field.

Annotations
@NativeType:uint32_t
maxPipelineRayHitAttributeSizeback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer maxPipelineRayHitAttributeSize(int value)

Sets the specified value to the VkRayTracingPipelineInterfaceCreateInfoKHR#maxPipelineRayHitAttributeSize field.

maxPipelineRayPayloadSizeback to summary
public int maxPipelineRayPayloadSize()
Returns:int

the value of the VkRayTracingPipelineInterfaceCreateInfoKHR#maxPipelineRayPayloadSize field.

Annotations
@NativeType:uint32_t
maxPipelineRayPayloadSizeback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer maxPipelineRayPayloadSize(int value)

Sets the specified value to the VkRayTracingPipelineInterfaceCreateInfoKHR#maxPipelineRayPayloadSize field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkRayTracingPipelineInterfaceCreateInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkRayTracingPipelineInterfaceCreateInfoKHR#pNext field.

selfback to summary
protected VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkRayTracingPipelineInterfaceCreateInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer sType(int value)

Sets the specified value to the VkRayTracingPipelineInterfaceCreateInfoKHR#sType field.

sType$Defaultback to summary
public VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHR value to the VkRayTracingPipelineInterfaceCreateInfoKHR#sType field.