VkBufferOpaqueCaptureAddressCreateInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkBufferOpaqueCaptureAddressCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Request a specific address for a buffer.
Description

If opaqueCaptureAddress is zero, no specific address is requested.

If opaqueCaptureAddress is not zero, then it should be an address retrieved from GetBufferOpaqueCaptureAddressKHR for an identically created buffer on the same implementation.

If this structure is not present, it is as if opaqueCaptureAddress is zero.

Apps should avoid creating buffers with app-provided addresses and implementation-provided addresses in the same process, to reduce the likelihood of ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR errors.

Note

The expected usage for this is that a trace capture/replay tool will add the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR flag to all buffers that use BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT_KHR, and during capture will save the queried opaque device addresses in the trace. During replay, the buffers will be created specifying the original address so any address values stored in the trace data will remain valid.

Implementations are expected to separate such buffers in the GPU address space so normal allocations will avoid using these addresses. Apps/tools should avoid mixing app-provided and implementation-provided addresses for buffers created with BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT_KHR, to avoid address space allocation conflicts.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO_KHR
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- opaqueCaptureAddress – the opaque capture address requested for the buffer.
Layout
```
 struct VkBufferOpaqueCaptureAddressCreateInfoKHR {
     VkStructureType sType;
     void const * pNext;
     uint64_t opaqueCaptureAddress;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` An array of `VkBufferOpaqueCaptureAddressCreateInfoKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`OPAQUECAPTUREADDRESS` The struct member offsets.
`static int`	`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 and Description
`VkBufferOpaqueCaptureAddressCreateInfoKHR(java.nio.ByteBuffer container)` Creates a `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`calloc()` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated with `memCalloc`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`callocStack()` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`create()` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated with `BufferUtils`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`create(long address)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance for the specified memory address.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance at the specified memory.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`malloc()` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated with `memAlloc`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`mallocStack()` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBufferOpaqueCaptureAddressCreateInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBufferOpaqueCaptureAddressCreateInfoKHR` instance allocated on the specified `MemoryStack`.
`static long`	`nopaqueCaptureAddress(long struct)` Unsafe version of `opaqueCaptureAddress()`.
`static void`	`nopaqueCaptureAddress(long struct, long value)` Unsafe version of `opaqueCaptureAddress`.
`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`	`opaqueCaptureAddress()` Returns the value of the `opaqueCaptureAddress` field.
`VkBufferOpaqueCaptureAddressCreateInfoKHR`	`opaqueCaptureAddress(long value)` Sets the specified value to the `opaqueCaptureAddress` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkBufferOpaqueCaptureAddressCreateInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkBufferOpaqueCaptureAddressCreateInfoKHR`	`set(int sType, long pNext, long opaqueCaptureAddress)` Initializes this struct with the specified values.
`VkBufferOpaqueCaptureAddressCreateInfoKHR`	`set(VkBufferOpaqueCaptureAddressCreateInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkBufferOpaqueCaptureAddressCreateInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.

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

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

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - OPAQUECAPTUREADDRESS
```
public static final int OPAQUECAPTUREADDRESS
```
    The struct member offsets.
- Constructor Detail
  - VkBufferOpaqueCaptureAddressCreateInfoKHR
```
public VkBufferOpaqueCaptureAddressCreateInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkBufferOpaqueCaptureAddressCreateInfoKHR 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()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - opaqueCaptureAddress
```
public long opaqueCaptureAddress()
```
    Returns the value of the opaqueCaptureAddress field.
  - sType
```
public VkBufferOpaqueCaptureAddressCreateInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkBufferOpaqueCaptureAddressCreateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - opaqueCaptureAddress
```
public VkBufferOpaqueCaptureAddressCreateInfoKHR opaqueCaptureAddress(long value)
```
    Sets the specified value to the opaqueCaptureAddress field.
  - set
```
public VkBufferOpaqueCaptureAddressCreateInfoKHR set(int sType,
                                                     long pNext,
                                                     long opaqueCaptureAddress)
```
    Initializes this struct with the specified values.
  - set
```
public VkBufferOpaqueCaptureAddressCreateInfoKHR set(VkBufferOpaqueCaptureAddressCreateInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR malloc()
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR calloc()
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR create()
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR create(long address)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkBufferOpaqueCaptureAddressCreateInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer create(long address,
                                                                      int capacity)
```
    Create a VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer createSafe(long address,
                                                                                    int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR mallocStack()
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR callocStack()
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer mallocStack(int capacity,
                                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer callocStack(int capacity,
                                                                           org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBufferOpaqueCaptureAddressCreateInfoKHR.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().
  - nopaqueCaptureAddress
```
public static long nopaqueCaptureAddress(long struct)
```
    Unsafe version of opaqueCaptureAddress().
  - 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.
  - nopaqueCaptureAddress
```
public static void nopaqueCaptureAddress(long struct,
                                         long value)
```
    Unsafe version of opaqueCaptureAddress.

Class VkBufferOpaqueCaptureAddressCreateInfoKHR

Description

Note

Valid Usage (Implicit)

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

OPAQUECAPTUREADDRESS

Constructor Detail

VkBufferOpaqueCaptureAddressCreateInfoKHR

Method Detail

sizeof

sType

pNext

opaqueCaptureAddress

sType

pNext

opaqueCaptureAddress

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nopaqueCaptureAddress

nsType

npNext

nopaqueCaptureAddress