Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBufferOpaqueCaptureAddressCreateInfo

extends Struct<VkBufferOpaqueCaptureAddressCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBufferOpaqueCaptureAddressCreateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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 GetBufferOpaqueCaptureAddress 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 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. 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)

Layout


struct VkBufferOpaqueCaptureAddressCreateInfo {
    VkStructureType sType;
    void const * pNext;
    uint64_t opaqueCaptureAddress;
}

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
OPAQUECAPTUREADDRESS

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
VkBufferOpaqueCaptureAddressCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkBufferOpaqueCaptureAddressCreateInfo
calloc()

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance allocated with memCalloc.

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

Returns a new VkBufferOpaqueCaptureAddressCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkBufferOpaqueCaptureAddressCreateInfo
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 VkBufferOpaqueCaptureAddressCreateInfo
create()

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance allocated with BufferUtils.

public static VkBufferOpaqueCaptureAddressCreateInfo
create(long address)

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance for the specified memory address.

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

Returns a new VkBufferOpaqueCaptureAddressCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkBufferOpaqueCaptureAddressCreateInfo.Buffer instance at the specified memory.

public static VkBufferOpaqueCaptureAddressCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkBufferOpaqueCaptureAddressCreateInfo
malloc()

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance allocated with memAlloc.

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

Returns a new VkBufferOpaqueCaptureAddressCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance allocated on the specified MemoryStack.

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

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

public static long
nopaqueCaptureAddress(long struct)

Unsafe version of opaqueCaptureAddress.

public static void
nopaqueCaptureAddress(long struct, long value)

Unsafe version of opaqueCaptureAddress.

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
opaqueCaptureAddress()

the opaque capture address requested for the buffer.

public VkBufferOpaqueCaptureAddressCreateInfo
opaqueCaptureAddress(long value)

Sets the specified value to the opaqueCaptureAddress field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBufferOpaqueCaptureAddressCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkBufferOpaqueCaptureAddressCreateInfo
set(int sType, long pNext, long opaqueCaptureAddress)

Initializes this struct with the specified values.

public VkBufferOpaqueCaptureAddressCreateInfo

Returns:

this struct
set
(VkBufferOpaqueCaptureAddressCreateInfo
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 VkBufferOpaqueCaptureAddressCreateInfo
sType(int value)

Sets the specified value to the sType field.

public VkBufferOpaqueCaptureAddressCreateInfo
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.

OPAQUECAPTUREADDRESSback to summary
public static final int OPAQUECAPTUREADDRESS

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

VkBufferOpaqueCaptureAddressCreateInfoback to summary
protected VkBufferOpaqueCaptureAddressCreateInfo(long address, ByteBuffer container)
VkBufferOpaqueCaptureAddressCreateInfoback to summary
public VkBufferOpaqueCaptureAddressCreateInfo(ByteBuffer container)

Creates a VkBufferOpaqueCaptureAddressCreateInfo 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 VkBufferOpaqueCaptureAddressCreateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBufferOpaqueCaptureAddressCreateInfo calloc(MemoryStack stack)

Returns a new VkBufferOpaqueCaptureAddressCreateInfo 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 VkBufferOpaqueCaptureAddressCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkBufferOpaqueCaptureAddressCreateInfo.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 VkBufferOpaqueCaptureAddressCreateInfo 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 VkBufferOpaqueCaptureAddressCreateInfo create()

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkBufferOpaqueCaptureAddressCreateInfo create(long address)

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance for the specified memory address.

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

Returns a new VkBufferOpaqueCaptureAddressCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkBufferOpaqueCaptureAddressCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBufferOpaqueCaptureAddressCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBufferOpaqueCaptureAddressCreateInfo malloc(MemoryStack stack)

Returns a new VkBufferOpaqueCaptureAddressCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nopaqueCaptureAddressback to summary
public static long nopaqueCaptureAddress(long struct)

Unsafe version of opaqueCaptureAddress.

nopaqueCaptureAddressback to summary
public static void nopaqueCaptureAddress(long struct, long value)

Unsafe version of opaqueCaptureAddress.

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.

opaqueCaptureAddressback to summary
public long opaqueCaptureAddress()

the opaque capture address requested for the buffer.

Annotations
@NativeType:uint64_t
opaqueCaptureAddressback to summary
public VkBufferOpaqueCaptureAddressCreateInfo opaqueCaptureAddress(long value)

Sets the specified value to the opaqueCaptureAddress field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkBufferOpaqueCaptureAddressCreateInfo set(int sType, long pNext, long opaqueCaptureAddress)

Initializes this struct with the specified values.

setback to summary
public VkBufferOpaqueCaptureAddressCreateInfo set(VkBufferOpaqueCaptureAddressCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkBufferOpaqueCaptureAddressCreateInfo

the source struct

Returns:VkBufferOpaqueCaptureAddressCreateInfo

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 VkBufferOpaqueCaptureAddressCreateInfo sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkBufferOpaqueCaptureAddressCreateInfo.Buffer

extends StructBuffer<VkBufferOpaqueCaptureAddressCreateInfo, VkBufferOpaqueCaptureAddressCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBufferOpaqueCaptureAddressCreateInfoKHR.Buffer

An array of VkBufferOpaqueCaptureAddressCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkBufferOpaqueCaptureAddressCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBufferOpaqueCaptureAddressCreateInfo.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 VkBufferOpaqueCaptureAddressCreateInfo
public long
public VkBufferOpaqueCaptureAddressCreateInfo.Buffer
public long

Returns:

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

public VkBufferOpaqueCaptureAddressCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkBufferOpaqueCaptureAddressCreateInfo#pNext field.

protected VkBufferOpaqueCaptureAddressCreateInfo.Buffer
public int

Returns:

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

public VkBufferOpaqueCaptureAddressCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkBufferOpaqueCaptureAddressCreateInfo#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBufferOpaqueCaptureAddressCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkBufferOpaqueCaptureAddressCreateInfo.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 VkBufferOpaqueCaptureAddressCreateInfo#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 VkBufferOpaqueCaptureAddressCreateInfo getElementFactory()

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

Annotations
@Override
opaqueCaptureAddressback to summary
public long opaqueCaptureAddress()
Returns:long

the value of the VkBufferOpaqueCaptureAddressCreateInfo#opaqueCaptureAddress field.

Annotations
@NativeType:uint64_t
opaqueCaptureAddressback to summary
public VkBufferOpaqueCaptureAddressCreateInfo.Buffer opaqueCaptureAddress(long value)

Sets the specified value to the VkBufferOpaqueCaptureAddressCreateInfo#opaqueCaptureAddress field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkBufferOpaqueCaptureAddressCreateInfo#pNext field.

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

Sets the specified value to the VkBufferOpaqueCaptureAddressCreateInfo#pNext field.

selfback to summary
protected VkBufferOpaqueCaptureAddressCreateInfo.Buffer self()

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

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

the value of the VkBufferOpaqueCaptureAddressCreateInfo#sType field.

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

Sets the specified value to the VkBufferOpaqueCaptureAddressCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_BUFFER_OPAQUE_CAPTURE_ADDRESS_CREATE_INFO value to the VkBufferOpaqueCaptureAddressCreateInfo#sType field.