Class VkBufferOpaqueCaptureAddressCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBufferOpaqueCaptureAddressCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBufferOpaqueCaptureAddressCreateInfoKHR
public class VkBufferOpaqueCaptureAddressCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceRequest a specific address for a buffer.Description
If
opaqueCaptureAddressis zero, no specific address is requested.If
opaqueCaptureAddressis not zero, then it should be an address retrieved fromGetBufferOpaqueCaptureAddressfor an identically created buffer on the same implementation.If this structure is not present, it is as if
opaqueCaptureAddressis 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_ADDRESSerrors.Note
The expected usage for this is that a trace capture/replay tool will add the
BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BITflag to all buffers that useBUFFER_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. Apps/tools should avoid mixing app-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 { VkStructureTypesType(); void const *pNext(); uint64_topaqueCaptureAddress(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkBufferOpaqueCaptureAddressCreateInfo.BufferAn array ofVkBufferOpaqueCaptureAddressCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intOPAQUECAPTUREADDRESS
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkBufferOpaqueCaptureAddressCreateInfo(java.nio.ByteBuffer container)Creates aVkBufferOpaqueCaptureAddressCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkBufferOpaqueCaptureAddressCreateInfocalloc()Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemCalloc.static VkBufferOpaqueCaptureAddressCreateInfo.Buffercalloc(int capacity)Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemCalloc.static VkBufferOpaqueCaptureAddressCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBufferOpaqueCaptureAddressCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBufferOpaqueCaptureAddressCreateInfocreate()Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withBufferUtils.static VkBufferOpaqueCaptureAddressCreateInfo.Buffercreate(int capacity)Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withBufferUtils.static VkBufferOpaqueCaptureAddressCreateInfocreate(long address)Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance for the specified memory address.static VkBufferOpaqueCaptureAddressCreateInfo.Buffercreate(long address, int capacity)Create aVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance at the specified memory.static VkBufferOpaqueCaptureAddressCreateInfocreateSafe(long address)static VkBufferOpaqueCaptureAddressCreateInfo.BuffercreateSafe(long address, int capacity)static VkBufferOpaqueCaptureAddressCreateInfomalloc()Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemAlloc.static VkBufferOpaqueCaptureAddressCreateInfo.Buffermalloc(int capacity)Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemAlloc.static VkBufferOpaqueCaptureAddressCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkBufferOpaqueCaptureAddressCreateInfomalloc(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.longopaqueCaptureAddress()the opaque capture address requested for the buffer.VkBufferOpaqueCaptureAddressCreateInfoopaqueCaptureAddress(long value)Sets the specified value to theopaqueCaptureAddress()field.longpNext()NULLor a pointer to a structure extending this structure.VkBufferOpaqueCaptureAddressCreateInfopNext(long value)Sets the specified value to thepNext()field.VkBufferOpaqueCaptureAddressCreateInfoset(int sType, long pNext, long opaqueCaptureAddress)Initializes this struct with the specified values.VkBufferOpaqueCaptureAddressCreateInfoset(VkBufferOpaqueCaptureAddressCreateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkBufferOpaqueCaptureAddressCreateInfosType(int value)Sets the specified value to thesType()field.VkBufferOpaqueCaptureAddressCreateInfosType$Default()Sets theSTRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFOvalue to thesType()field.
-
-
-
Constructor Detail
-
VkBufferOpaqueCaptureAddressCreateInfo
public VkBufferOpaqueCaptureAddressCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
public VkBufferOpaqueCaptureAddressCreateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkBufferOpaqueCaptureAddressCreateInfo sType$Default()
Sets theSTRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFOvalue to thesType()field.
-
pNext
public VkBufferOpaqueCaptureAddressCreateInfo pNext(long value)
Sets the specified value to thepNext()field.
-
opaqueCaptureAddress
public VkBufferOpaqueCaptureAddressCreateInfo opaqueCaptureAddress(long value)
Sets the specified value to theopaqueCaptureAddress()field.
-
set
public VkBufferOpaqueCaptureAddressCreateInfo set(int sType, long pNext, long opaqueCaptureAddress)
Initializes this struct with the specified values.
-
set
public VkBufferOpaqueCaptureAddressCreateInfo set(VkBufferOpaqueCaptureAddressCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkBufferOpaqueCaptureAddressCreateInfo malloc()
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkBufferOpaqueCaptureAddressCreateInfo calloc()
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkBufferOpaqueCaptureAddressCreateInfo create()
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated withBufferUtils.
-
create
public static VkBufferOpaqueCaptureAddressCreateInfo create(long address)
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkBufferOpaqueCaptureAddressCreateInfo createSafe(long address)
-
malloc
public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer malloc(int capacity)
Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer calloc(int capacity)
Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer create(int capacity)
Returns a newVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer create(long address, int capacity)
Create aVkBufferOpaqueCaptureAddressCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkBufferOpaqueCaptureAddressCreateInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static VkBufferOpaqueCaptureAddressCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBufferOpaqueCaptureAddressCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkBufferOpaqueCaptureAddressCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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.
-
-