Package org.lwjgl.vulkan

Class VkPhysicalDeviceBufferDeviceAddressFeatures

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceBufferDeviceAddressFeatures>

org.lwjgl.vulkan.VkPhysicalDeviceBufferDeviceAddressFeatures

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkPhysicalDeviceBufferDeviceAddressFeaturesKHR

public class VkPhysicalDeviceBufferDeviceAddressFeatures
extends org.lwjgl.system.Struct<VkPhysicalDeviceBufferDeviceAddressFeatures>
implements org.lwjgl.system.NativeResource

Structure describing buffer address features that can be supported by an implementation.

Description

Note

bufferDeviceAddressMultiDevice exists to allow certain legacy platforms to be able to support bufferDeviceAddress without needing to support shared GPU virtual addresses for multi-device configurations.

See GetBufferDeviceAddress for more information.

If the VkPhysicalDeviceBufferDeviceAddressFeatures structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceBufferDeviceAddressFeatures can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES

Layout

 struct VkPhysicalDeviceBufferDeviceAddressFeatures {
     VkStructureType sType();
     void * pNext();
     VkBool32 bufferDeviceAddress();
     VkBool32 bufferDeviceAddressCaptureReplay();
     VkBool32 bufferDeviceAddressMultiDevice();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	An array of VkPhysicalDeviceBufferDeviceAddressFeatures structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFERDEVICEADDRESS	The struct member offsets.
static final int	BUFFERDEVICEADDRESSCAPTUREREPLAY	The struct member offsets.
static final int	BUFFERDEVICEADDRESSMULTIDEVICE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkPhysicalDeviceBufferDeviceAddressFeatures(ByteBuffer container)	Creates a VkPhysicalDeviceBufferDeviceAddressFeatures instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
boolean	bufferDeviceAddress()	indicates that the implementation supports accessing buffer memory in shaders as storage buffers via an address queried from GetBufferDeviceAddress.
VkPhysicalDeviceBufferDeviceAddressFeatures	bufferDeviceAddress(boolean value)	Sets the specified value to the bufferDeviceAddress() field.
boolean	bufferDeviceAddressCaptureReplay()	indicates that the implementation supports saving and reusing buffer and device addresses, e.g.
VkPhysicalDeviceBufferDeviceAddressFeatures	bufferDeviceAddressCaptureReplay(boolean value)	Sets the specified value to the bufferDeviceAddressCaptureReplay() field.
boolean	bufferDeviceAddressMultiDevice()	indicates that the implementation supports the bufferDeviceAddress , rayTracingPipeline and rayQuery features for logical devices created with multiple physical devices.
VkPhysicalDeviceBufferDeviceAddressFeatures	bufferDeviceAddressMultiDevice(boolean value)	Sets the specified value to the bufferDeviceAddressMultiDevice() field.
static VkPhysicalDeviceBufferDeviceAddressFeatures	calloc()	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated with memCalloc.
static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceBufferDeviceAddressFeatures	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceBufferDeviceAddressFeatures	create()	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated with BufferUtils.
static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceBufferDeviceAddressFeatures	create(long address)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance for the specified memory address.
static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceBufferDeviceAddressFeatures	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceBufferDeviceAddressFeatures	malloc()	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated with memAlloc.
static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceBufferDeviceAddressFeatures	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated on the specified MemoryStack.
static int	nbufferDeviceAddress(long struct)	Unsafe version of bufferDeviceAddress().
static void	nbufferDeviceAddress(long struct, int value)	Unsafe version of bufferDeviceAddress.
static int	nbufferDeviceAddressCaptureReplay(long struct)	Unsafe version of bufferDeviceAddressCaptureReplay().
static void	nbufferDeviceAddressCaptureReplay(long struct, int value)	Unsafe version of bufferDeviceAddressCaptureReplay.
static int	nbufferDeviceAddressMultiDevice(long struct)	Unsafe version of bufferDeviceAddressMultiDevice().
static void	nbufferDeviceAddressMultiDevice(long struct, int value)	Unsafe version of bufferDeviceAddressMultiDevice.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceBufferDeviceAddressFeatures	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceBufferDeviceAddressFeatures	set(int sType, long pNext, boolean bufferDeviceAddress, boolean bufferDeviceAddressCaptureReplay, boolean bufferDeviceAddressMultiDevice)	Initializes this struct with the specified values.
VkPhysicalDeviceBufferDeviceAddressFeatures	set(VkPhysicalDeviceBufferDeviceAddressFeatures src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceBufferDeviceAddressFeatures	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceBufferDeviceAddressFeatures	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

BUFFERDEVICEADDRESS

public static final int BUFFERDEVICEADDRESS

The struct member offsets.

BUFFERDEVICEADDRESSCAPTUREREPLAY

public static final int BUFFERDEVICEADDRESSCAPTUREREPLAY

The struct member offsets.

BUFFERDEVICEADDRESSMULTIDEVICE

public static final int BUFFERDEVICEADDRESSMULTIDEVICE

The struct member offsets.

Constructor Details

VkPhysicalDeviceBufferDeviceAddressFeatures

public VkPhysicalDeviceBufferDeviceAddressFeatures(ByteBuffer container)

Creates a VkPhysicalDeviceBufferDeviceAddressFeatures 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPhysicalDeviceBufferDeviceAddressFeatures>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

bufferDeviceAddress

public boolean bufferDeviceAddress()

indicates that the implementation supports accessing buffer memory in shaders as storage buffers via an address queried from GetBufferDeviceAddress.

bufferDeviceAddressCaptureReplay

public boolean bufferDeviceAddressCaptureReplay()

indicates that the implementation supports saving and reusing buffer and device addresses, e.g. for trace capture and replay.

bufferDeviceAddressMultiDevice

public boolean bufferDeviceAddressMultiDevice()

indicates that the implementation supports the bufferDeviceAddress , rayTracingPipeline and rayQuery features for logical devices created with multiple physical devices. If this feature is not supported, buffer and acceleration structure addresses must not be queried on a logical device created with more than one physical device.

sType

public VkPhysicalDeviceBufferDeviceAddressFeatures sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceBufferDeviceAddressFeatures sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_BUFFER_DEVICE_ADDRESS_FEATURES value to the sType() field.

pNext

public VkPhysicalDeviceBufferDeviceAddressFeatures pNext(long value)

Sets the specified value to the pNext() field.

bufferDeviceAddress

public VkPhysicalDeviceBufferDeviceAddressFeatures bufferDeviceAddress(boolean value)

Sets the specified value to the bufferDeviceAddress() field.

bufferDeviceAddressCaptureReplay

public VkPhysicalDeviceBufferDeviceAddressFeatures bufferDeviceAddressCaptureReplay(boolean value)

Sets the specified value to the bufferDeviceAddressCaptureReplay() field.

bufferDeviceAddressMultiDevice

public VkPhysicalDeviceBufferDeviceAddressFeatures bufferDeviceAddressMultiDevice(boolean value)

Sets the specified value to the bufferDeviceAddressMultiDevice() field.

set

public VkPhysicalDeviceBufferDeviceAddressFeatures set(int sType,
 long pNext,
 boolean bufferDeviceAddress,
 boolean bufferDeviceAddressCaptureReplay,
 boolean bufferDeviceAddressMultiDevice)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceBufferDeviceAddressFeatures set(VkPhysicalDeviceBufferDeviceAddressFeatures src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures malloc()

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

calloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures calloc()

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

create

public static VkPhysicalDeviceBufferDeviceAddressFeatures create()

Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated with BufferUtils.

create

public static VkPhysicalDeviceBufferDeviceAddressFeatures create(long address)

Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceBufferDeviceAddressFeatures createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer create(int capacity)

Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceBufferDeviceAddressFeatures instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceBufferDeviceAddressFeatures.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nbufferDeviceAddress

public static int nbufferDeviceAddress(long struct)

Unsafe version of bufferDeviceAddress().

nbufferDeviceAddressCaptureReplay

public static int nbufferDeviceAddressCaptureReplay(long struct)

Unsafe version of bufferDeviceAddressCaptureReplay().

nbufferDeviceAddressMultiDevice

public static int nbufferDeviceAddressMultiDevice(long struct)

Unsafe version of bufferDeviceAddressMultiDevice().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nbufferDeviceAddress

public static void nbufferDeviceAddress(long struct,
 int value)

Unsafe version of bufferDeviceAddress.

nbufferDeviceAddressCaptureReplay

public static void nbufferDeviceAddressCaptureReplay(long struct,
 int value)

Unsafe version of bufferDeviceAddressCaptureReplay.

nbufferDeviceAddressMultiDevice

public static void nbufferDeviceAddressMultiDevice(long struct,
 int value)

Unsafe version of bufferDeviceAddressMultiDevice.