Structure specifying the buffer to query an address for.

Valid Usage

If buffer is non-sparse and was not created with the BUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT flag, then it must be bound completely and contiguously to a single VkDeviceMemory object
buffer must have been created with BUFFER_USAGE_SHADER_DEVICE_ADDRESS_BIT

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO
pNext must be NULL
buffer must be a valid VkBuffer handle

Layout


struct VkBufferDeviceAddressInfo {
    VkStructureType sType;
    void const * pNext;
    VkBuffer buffer;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkBufferDeviceAddressInfo.Buffer An array of `VkBufferDeviceAddressInfo` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	BUFFER 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkBufferDeviceAddressInfo(long address, ByteBuffer container)
public	VkBufferDeviceAddressInfo(ByteBuffer container) Creates a `VkBufferDeviceAddressInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public long	buffer() specifies the buffer whose address is being queried.
public VkBufferDeviceAddressInfo	buffer(long value) Sets the specified value to the `buffer` field.
public static VkBufferDeviceAddressInfo	calloc() Returns a new `VkBufferDeviceAddressInfo` instance allocated with `memCalloc`.
public static VkBufferDeviceAddressInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated with `memCalloc`.
public static VkBufferDeviceAddressInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBufferDeviceAddressInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkBufferDeviceAddressInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkBufferDeviceAddressInfo	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 VkBufferDeviceAddressInfo	create() Returns a new `VkBufferDeviceAddressInfo` instance allocated with `BufferUtils`.
public static VkBufferDeviceAddressInfo	create(long address) Returns a new `VkBufferDeviceAddressInfo` instance for the specified memory address.
public static VkBufferDeviceAddressInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated with `BufferUtils`.
public static VkBufferDeviceAddressInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkBufferDeviceAddressInfo.Buffer` instance at the specified memory.
public static VkBufferDeviceAddressInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkBufferDeviceAddressInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkBufferDeviceAddressInfo	malloc() Returns a new `VkBufferDeviceAddressInfo` instance allocated with `memAlloc`.
public static VkBufferDeviceAddressInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated with `memAlloc`.
public static VkBufferDeviceAddressInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkBufferDeviceAddressInfo` instance allocated on the specified `MemoryStack`.
public static VkBufferDeviceAddressInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static long	nbuffer(long struct) Unsafe version of `buffer`.
public static void	nbuffer(long struct, long value) Unsafe version of `buffer`.
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	pNext() `NULL` or a pointer to a structure extending this structure.
public VkBufferDeviceAddressInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkBufferDeviceAddressInfo	set(int sType, long pNext, long buffer) Initializes this struct with the specified values.
public VkBufferDeviceAddressInfo	Returns: this struct set(VkBufferDeviceAddressInfo 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 VkBufferDeviceAddressInfo	sType(int value) Sets the specified value to the `sType` field.
public VkBufferDeviceAddressInfo	sType$Default() Sets the `STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

BUFFER	back to summary
public static final int BUFFER The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkBufferDeviceAddressInfo	back to summary
protected VkBufferDeviceAddressInfo(long address, ByteBuffer container)

VkBufferDeviceAddressInfo back to summary

VkBufferDeviceAddressInfo	back to summary
public VkBufferDeviceAddressInfo(ByteBuffer container) Creates a `VkBufferDeviceAddressInfo` 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.

public VkBufferDeviceAddressInfo(ByteBuffer container)

Creates a VkBufferDeviceAddressInfo 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

buffer	back to summary
public long buffer() specifies the buffer whose address is being queried. Annotations @NativeType:VkBuffer

buffer

back to summary

public long buffer()

specifies the buffer whose address is being queried.

Annotations

@NativeType:VkBuffer

buffer	back to summary
public VkBufferDeviceAddressInfo buffer(long value) Sets the specified value to the `buffer` field.

calloc	back to summary
public static VkBufferDeviceAddressInfo calloc() Returns a new `VkBufferDeviceAddressInfo` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkBufferDeviceAddressInfo.Buffer calloc(int capacity) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkBufferDeviceAddressInfo.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkBufferDeviceAddressInfo calloc(MemoryStack stack) Returns a new `VkBufferDeviceAddressInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkBufferDeviceAddressInfo calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkBufferDeviceAddressInfo.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkBufferDeviceAddressInfo.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

public static VkBufferDeviceAddressInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkBufferDeviceAddressInfo.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

create back to summary

create	back to summary
protected VkBufferDeviceAddressInfo 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

protected VkBufferDeviceAddressInfo 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

create	back to summary
public static VkBufferDeviceAddressInfo create() Returns a new `VkBufferDeviceAddressInfo` instance allocated with `BufferUtils`.

create	back to summary
public static VkBufferDeviceAddressInfo create(long address) Returns a new `VkBufferDeviceAddressInfo` instance for the specified memory address.

create back to summary

create	back to summary
public static VkBufferDeviceAddressInfo.Buffer create(int capacity) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkBufferDeviceAddressInfo.Buffer create(int capacity)

Returns a new VkBufferDeviceAddressInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkBufferDeviceAddressInfo.Buffer create(long address, int capacity) Create a `VkBufferDeviceAddressInfo.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkBufferDeviceAddressInfo.Buffer create(long address, int capacity)

Create a VkBufferDeviceAddressInfo.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkBufferDeviceAddressInfo createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkBufferDeviceAddressInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkBufferDeviceAddressInfo.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkBufferDeviceAddressInfo malloc() Returns a new `VkBufferDeviceAddressInfo` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkBufferDeviceAddressInfo.Buffer malloc(int capacity) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkBufferDeviceAddressInfo.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkBufferDeviceAddressInfo malloc(MemoryStack stack) Returns a new `VkBufferDeviceAddressInfo` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkBufferDeviceAddressInfo malloc(MemoryStack stack)

Returns a new VkBufferDeviceAddressInfo instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkBufferDeviceAddressInfo.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkBufferDeviceAddressInfo.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkBufferDeviceAddressInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nbuffer	back to summary
public static long nbuffer(long struct) Unsafe version of `buffer`.

nbuffer	back to summary
public static void nbuffer(long struct, long value) Unsafe version of `buffer`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkBufferDeviceAddressInfo pNext(long value) Sets the specified value to the `pNext` field.

set	back to summary
public VkBufferDeviceAddressInfo set(int sType, long pNext, long buffer) Initializes this struct with the specified values.

set	back to summary
public VkBufferDeviceAddressInfo set(VkBufferDeviceAddressInfo src) Copies the specified struct data to this struct. Parameters src:VkBufferDeviceAddressInfo the source struct Returns:VkBufferDeviceAddressInfo this struct

set

back to summary

public VkBufferDeviceAddressInfo set(VkBufferDeviceAddressInfo src)

Copies the specified struct data to this struct.

Parameters

src:VkBufferDeviceAddressInfo: the source struct

Returns:VkBufferDeviceAddressInfo

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

sType back to summary

sType	back to summary
public int sType() a `VkStructureType` value identifying this structure. Annotations @NativeType:VkStructureType

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkBufferDeviceAddressInfo sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkBufferDeviceAddressInfo sType$Default() Sets the `STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkBufferDeviceAddressInfo.Buffer

Class Inheritance

extends StructBuffer<VkBufferDeviceAddressInfo, VkBufferDeviceAddressInfo.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkBufferDeviceAddressInfo.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

Known Direct Subclasses

org.lwjgl.vulkan.VkBufferDeviceAddressInfoEXT.Buffer, org.lwjgl.vulkan.VkBufferDeviceAddressInfoKHR.Buffer

An array of VkBufferDeviceAddressInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VkBufferDeviceAddressInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkBufferDeviceAddressInfo.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 Type	Method and Description
public long	Returns: the value of the `VkBufferDeviceAddressInfo#buffer` field. buffer()
public VkBufferDeviceAddressInfo.Buffer	buffer(long value) Sets the specified value to the `VkBufferDeviceAddressInfo#buffer` field.
protected VkBufferDeviceAddressInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `VkBufferDeviceAddressInfo#pNext` field. pNext()
public VkBufferDeviceAddressInfo.Buffer	pNext(long value) Sets the specified value to the `VkBufferDeviceAddressInfo#pNext` field.
protected VkBufferDeviceAddressInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkBufferDeviceAddressInfo#sType` field. sType()
public VkBufferDeviceAddressInfo.Buffer	sType(int value) Sets the specified value to the `VkBufferDeviceAddressInfo#sType` field.
public VkBufferDeviceAddressInfo.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO` value to the `VkBufferDeviceAddressInfo#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkBufferDeviceAddressInfo ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkBufferDeviceAddressInfo.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 `VkBufferDeviceAddressInfo#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkBufferDeviceAddressInfo.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 VkBufferDeviceAddressInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

buffer	back to summary
public long buffer() Returns:long the value of the `VkBufferDeviceAddressInfo#buffer` field. Annotations @NativeType:VkBuffer

buffer	back to summary
public VkBufferDeviceAddressInfo.Buffer buffer(long value) Sets the specified value to the `VkBufferDeviceAddressInfo#buffer` field.

getElementFactory

back to summary

protected VkBufferDeviceAddressInfo getElementFactory()

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

Annotations

@Override

pNext	back to summary
public long pNext() Returns:long the value of the `VkBufferDeviceAddressInfo#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkBufferDeviceAddressInfo.Buffer pNext(long value) Sets the specified value to the `VkBufferDeviceAddressInfo#pNext` field.

self

back to summary

protected VkBufferDeviceAddressInfo.Buffer self()

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

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkBufferDeviceAddressInfo#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkBufferDeviceAddressInfo.Buffer sType(int value) Sets the specified value to the `VkBufferDeviceAddressInfo#sType` field.

sType$Default	back to summary
public VkBufferDeviceAddressInfo.Buffer sType$Default() Sets the `STRUCTURE_TYPE_BUFFER_DEVICE_ADDRESS_INFO` value to the `VkBufferDeviceAddressInfo#sType` field.

public Class VkBufferDeviceAddressInfo

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkBufferDeviceAddressInfo.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail