Class VkBufferOpaqueCaptureAddressCreateInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBufferOpaqueCaptureAddressCreateInfoKHR
Description
If opaqueCaptureAddress is zero, no specific address is requested.
If opaqueCaptureAddress is not zero, then it should be an address retrieved from GetBufferOpaqueCaptureAddress for an identically created buffer on the same implementation.
If this structure is not present, it is as if opaqueCaptureAddress is zero.
Applications should avoid creating buffers with application-provided addresses and implementation-provided addresses in the same process, to reduce the likelihood of ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS errors.
Note
The expected usage for this is that a trace capture/replay tool will add the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT flag to all buffers that use BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT, 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. Applications and tools should avoid mixing application-provided and implementation-provided addresses for buffers created with BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT, to avoid address space allocation conflicts.
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO
Layout
struct VkBufferOpaqueCaptureAddressCreateInfo {
VkStructureType sType();
void const * pNext();
uint64_t opaqueCaptureAddress();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkBufferOpaqueCaptureAddressCreateInfostructs.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 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
ConstructorsConstructorDescriptionVkBufferOpaqueCaptureAddressCreateInfo(ByteBuffer container) Creates aVkBufferOpaqueCaptureAddressCreateInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance for the specified memory address.create(long address, int capacity) Create aVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance at the specified memory.static @Nullable VkBufferOpaqueCaptureAddressCreateInfocreateSafe(long address) static @Nullable VkBufferOpaqueCaptureAddressCreateInfo.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated on the specifiedMemoryStack.static longnopaqueCaptureAddress(long struct) Unsafe version ofopaqueCaptureAddress().static voidnopaqueCaptureAddress(long struct, long value) Unsafe version ofopaqueCaptureAddress.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.longthe opaque capture address requested for the buffer.opaqueCaptureAddress(long value) Sets the specified value to theopaqueCaptureAddress()field.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, long opaqueCaptureAddress) 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_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFOvalue 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. -
OPAQUECAPTUREADDRESS
public static final int OPAQUECAPTUREADDRESSThe struct member offsets.
-
-
Constructor Details
-
VkBufferOpaqueCaptureAddressCreateInfo
Creates aVkBufferOpaqueCaptureAddressCreateInfoinstance 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<VkBufferOpaqueCaptureAddressCreateInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
opaqueCaptureAddress
public long opaqueCaptureAddress()the opaque capture address requested for the buffer. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
opaqueCaptureAddress
Sets the specified value to theopaqueCaptureAddress()field. -
set
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 newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withBufferUtils. -
create
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkBufferOpaqueCaptureAddressCreateInfo.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBufferOpaqueCaptureAddressCreateInfo.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(). -
nopaqueCaptureAddress
public static long nopaqueCaptureAddress(long struct) Unsafe version ofopaqueCaptureAddress(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nopaqueCaptureAddress
public static void nopaqueCaptureAddress(long struct, long value) Unsafe version ofopaqueCaptureAddress.
-