java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkRayTracingPipelineInterfaceCreateInfoKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkRayTracingPipelineInterfaceCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
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
- maxPipelineRayHitAttributeSize must be less than or equal to VkPhysicalDeviceRayTracingPipelinePropertiesKHR::maxRayHitAttributeSize
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHR
- pNext must be NULL
See Also

VkRayTracingPipelineCreateInfoKHR

Layout
```
 struct VkRayTracingPipelineInterfaceCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t maxPipelineRayPayloadSize();
     uint32_t maxPipelineRayHitAttributeSize();
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer
An array of VkRayTracingPipelineInterfaceCreateInfoKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default
- Nested classes/interfaces inherited from class org.lwjgl.system.Struct
  org.lwjgl.system.Struct.StructValidation

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`ALIGNOF`	The struct alignment in bytes.
`static int`	`MAXPIPELINERAYHITATTRIBUTESIZE MAXPIPELINERAYPAYLOADSIZE PNEXT`	The struct member offsets.
`static int`	`SIZEOF`	The struct size in bytes.
`static int`	`STYPE`	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor	Description
`VkRayTracingPipelineInterfaceCreateInfoKHR(java.nio.ByteBuffer container)`	Creates a `VkRayTracingPipelineInterfaceCreateInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`calloc()`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR` instance allocated with `memCalloc`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`calloc(int capacity)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`calloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`calloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`create()`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR` instance allocated with `BufferUtils`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`create(int capacity)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`create(long address)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR` instance for the specified memory address.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`create(long address, int capacity)`	Create a `VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer` instance at the specified memory.
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`createSafe(long address)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`createSafe(long address, int capacity)`	Like `create`, but returns `null` if `address` is `NULL`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`malloc()`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR` instance allocated with `memAlloc`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`malloc(int capacity)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer`	`malloc(int capacity, org.lwjgl.system.MemoryStack stack)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkRayTracingPipelineInterfaceCreateInfoKHR`	`malloc(org.lwjgl.system.MemoryStack stack)`	Returns a new `VkRayTracingPipelineInterfaceCreateInfoKHR` instance allocated on the specified `MemoryStack`.
`int`	`maxPipelineRayHitAttributeSize()`	the maximum attribute structure size in bytes used by any shader in the pipeline.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`maxPipelineRayHitAttributeSize(int value)`	Sets the specified value to the `maxPipelineRayHitAttributeSize()` field.
`int`	`maxPipelineRayPayloadSize()`	the maximum payload size in bytes used by any shader in the pipeline.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`maxPipelineRayPayloadSize(int value)`	Sets the specified value to the `maxPipelineRayPayloadSize()` field.
`static int`	`nmaxPipelineRayHitAttributeSize(long struct)`	Unsafe version of `maxPipelineRayHitAttributeSize()`.
`static void`	`nmaxPipelineRayHitAttributeSize(long struct, int value)`	Unsafe version of `maxPipelineRayHitAttributeSize`.
`static int`	`nmaxPipelineRayPayloadSize(long struct)`	Unsafe version of `maxPipelineRayPayloadSize()`.
`static void`	`nmaxPipelineRayPayloadSize(long struct, int value)`	Unsafe version of `maxPipelineRayPayloadSize`.
`static long`	`npNext(long struct)`	Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)`	Unsafe version of `pNext`.
`static int`	`nsType(long struct)`	Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)`	Unsafe version of `sType`.
`long`	`pNext()`	`NULL` or a pointer to a structure extending this structure.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`pNext(long value)`	Sets the specified value to the `pNext()` field.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`set(int sType, long pNext, int maxPipelineRayPayloadSize, int maxPipelineRayHitAttributeSize)`	Initializes this struct with the specified values.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`set(VkRayTracingPipelineInterfaceCreateInfoKHR src)`	Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()`	the type of this structure.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`sType(int value)`	Sets the specified value to the `sType()` field.
`VkRayTracingPipelineInterfaceCreateInfoKHR`	`sType$Default()`	Sets the `STRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHR` value to the `sType()` field.

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate

- Field Detail
  - SIZEOF
    
    The struct size in bytes.
  - ALIGNOF
    
    The struct alignment in bytes.
  - STYPE, PNEXT, MAXPIPELINERAYPAYLOADSIZE, MAXPIPELINERAYHITATTRIBUTESIZE
    
    The struct member offsets.
- Constructor Detail
  - VkRayTracingPipelineInterfaceCreateInfoKHR
```
public VkRayTracingPipelineInterfaceCreateInfoKHR(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    the type of this structure.
  - pNext
```
public long pNext()
```
    NULL or 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
```
public VkRayTracingPipelineInterfaceCreateInfoKHR sType(int value)
```
    Sets the specified value to the sType() field.
  - sType$Default
```
public VkRayTracingPipelineInterfaceCreateInfoKHR sType$Default()
```
    Sets the STRUCTURE_TYPE_RAY_TRACING_PIPELINE_INTERFACE_CREATE_INFO_KHR value to the sType() field.
  - pNext
```
public VkRayTracingPipelineInterfaceCreateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext() field.
  - maxPipelineRayPayloadSize
```
public VkRayTracingPipelineInterfaceCreateInfoKHR maxPipelineRayPayloadSize(int value)
```
    Sets the specified value to the maxPipelineRayPayloadSize() field.
  - maxPipelineRayHitAttributeSize
```
public VkRayTracingPipelineInterfaceCreateInfoKHR maxPipelineRayHitAttributeSize(int value)
```
    Sets the specified value to the maxPipelineRayHitAttributeSize() 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
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR malloc()
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR calloc()
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR create()
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR create(long address)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkRayTracingPipelineInterfaceCreateInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer create(long address,
                                                                       int capacity)
```
    Create a VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer createSafe(long address,
                                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - calloc
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR calloc(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR instance allocated on the specified MemoryStack and 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 new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - calloc
```
public static VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer calloc(int capacity,
                                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkRayTracingPipelineInterfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nmaxPipelineRayPayloadSize
```
public static int nmaxPipelineRayPayloadSize(long struct)
```
    Unsafe version of maxPipelineRayPayloadSize().
  - nmaxPipelineRayHitAttributeSize
```
public static int nmaxPipelineRayHitAttributeSize(long struct)
```
    Unsafe version of maxPipelineRayHitAttributeSize().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nmaxPipelineRayPayloadSize
```
public static void nmaxPipelineRayPayloadSize(long struct,
                                              int value)
```
    Unsafe version of maxPipelineRayPayloadSize.
  - nmaxPipelineRayHitAttributeSize
```
public static void nmaxPipelineRayHitAttributeSize(long struct,
                                                   int value)
```
    Unsafe version of maxPipelineRayHitAttributeSize.

Class VkRayTracingPipelineInterfaceCreateInfoKHR

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from interface org.lwjgl.system.NativeResource

Methods inherited from class java.lang.Object

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class org.lwjgl.system.Struct

Field Detail

SIZEOF

ALIGNOF

STYPE, PNEXT, MAXPIPELINERAYPAYLOADSIZE, MAXPIPELINERAYHITATTRIBUTESIZE

Constructor Detail

VkRayTracingPipelineInterfaceCreateInfoKHR

Method Detail

sizeof

sType

pNext

maxPipelineRayPayloadSize

maxPipelineRayHitAttributeSize

sType

sType$Default

pNext

maxPipelineRayPayloadSize

maxPipelineRayHitAttributeSize

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nmaxPipelineRayPayloadSize

nmaxPipelineRayHitAttributeSize

nsType

npNext

nmaxPipelineRayPayloadSize

nmaxPipelineRayHitAttributeSize