Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryOpaqueCaptureAddressAllocateInfo

extends Struct<VkMemoryOpaqueCaptureAddressAllocateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkMemoryOpaqueCaptureAddressAllocateInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Request a specific address for a memory allocation.
Description

If opaqueCaptureAddress is zero, no specific address is requested.

If opaqueCaptureAddress is not zero, it should be an address retrieved from GetDeviceMemoryOpaqueCaptureAddress on an identically created memory allocation on the same implementation.

Note

In most cases, it is expected that a non-zero opaqueAddress is an address retrieved from GetDeviceMemoryOpaqueCaptureAddress on an identically created memory allocation. If this is not the case, it is likely that ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS errors will occur.

This is, however, not a strict requirement because trace capture/replay tools may need to adjust memory allocation parameters for imported memory.

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

Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer

An array of VkMemoryOpaqueCaptureAddressAllocateInfo structs.

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
VkMemoryOpaqueCaptureAddressAllocateInfo(long address, ByteBuffer container)

public
VkMemoryOpaqueCaptureAddressAllocateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMemoryOpaqueCaptureAddressAllocateInfo
calloc()

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance allocated with memCalloc.

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance allocated with BufferUtils.

public static VkMemoryOpaqueCaptureAddressAllocateInfo
create(long address)

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance for the specified memory address.

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer instance at the specified memory.

public static VkMemoryOpaqueCaptureAddressAllocateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkMemoryOpaqueCaptureAddressAllocateInfo
malloc()

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance allocated with memAlloc.

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance allocated on the specified MemoryStack.

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo.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 memory allocation.

public VkMemoryOpaqueCaptureAddressAllocateInfo
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 VkMemoryOpaqueCaptureAddressAllocateInfo
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkMemoryOpaqueCaptureAddressAllocateInfo

Returns:

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

Sets the specified value to the sType field.

public VkMemoryOpaqueCaptureAddressAllocateInfo
sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO value to the sType field.

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

VkMemoryOpaqueCaptureAddressAllocateInfoback to summary
protected VkMemoryOpaqueCaptureAddressAllocateInfo(long address, ByteBuffer container)
VkMemoryOpaqueCaptureAddressAllocateInfoback to summary
public VkMemoryOpaqueCaptureAddressAllocateInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMemoryOpaqueCaptureAddressAllocateInfo calloc(MemoryStack stack)

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

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance allocated with BufferUtils.

createback to summary
public static VkMemoryOpaqueCaptureAddressAllocateInfo create(long address)

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance for the specified memory address.

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryOpaqueCaptureAddressAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryOpaqueCaptureAddressAllocateInfo malloc(MemoryStack stack)

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new VkMemoryOpaqueCaptureAddressAllocateInfo.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 memory allocation.

Annotations
@NativeType:uint64_t
opaqueCaptureAddressback to summary
public VkMemoryOpaqueCaptureAddressAllocateInfo 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 VkMemoryOpaqueCaptureAddressAllocateInfo pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkMemoryOpaqueCaptureAddressAllocateInfo set(VkMemoryOpaqueCaptureAddressAllocateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkMemoryOpaqueCaptureAddressAllocateInfo

the source struct

Returns:VkMemoryOpaqueCaptureAddressAllocateInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer

extends StructBuffer<VkMemoryOpaqueCaptureAddressAllocateInfo, VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkMemoryOpaqueCaptureAddressAllocateInfoKHR.Buffer
An array of VkMemoryOpaqueCaptureAddressAllocateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryOpaqueCaptureAddressAllocateInfo
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public long

Returns:

the value of the VkMemoryOpaqueCaptureAddressAllocateInfo#opaqueCaptureAddress field.
opaqueCaptureAddress()

public VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer
opaqueCaptureAddress(long value)

Sets the specified value to the VkMemoryOpaqueCaptureAddressAllocateInfo#opaqueCaptureAddress field.

public long

Returns:

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

public VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer
pNext(long value)

Sets the specified value to the VkMemoryOpaqueCaptureAddressAllocateInfo#pNext field.

protected VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer
self()

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

public int

Returns:

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

public VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer
sType(int value)

Sets the specified value to the VkMemoryOpaqueCaptureAddressAllocateInfo#sType field.

public VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO value to the VkMemoryOpaqueCaptureAddressAllocateInfo#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryOpaqueCaptureAddressAllocateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkMemoryOpaqueCaptureAddressAllocateInfo#opaqueCaptureAddress field.

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

Sets the specified value to the VkMemoryOpaqueCaptureAddressAllocateInfo#opaqueCaptureAddress field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMemoryOpaqueCaptureAddressAllocateInfo#pNext field.

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

Sets the specified value to the VkMemoryOpaqueCaptureAddressAllocateInfo#pNext field.

selfback to summary
protected VkMemoryOpaqueCaptureAddressAllocateInfo.Buffer self()

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

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

the value of the VkMemoryOpaqueCaptureAddressAllocateInfo#sType field.

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

Sets the specified value to the VkMemoryOpaqueCaptureAddressAllocateInfo#sType field.

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

Sets the STRUCTURE_TYPE_MEMORY_OPAQUE_CAPTURE_ADDRESS_ALLOCATE_INFO value to the VkMemoryOpaqueCaptureAddressAllocateInfo#sType field.