Package org.lwjgl.vulkan

Class VkStridedDeviceAddressRegionKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkStridedDeviceAddressRegionKHR>

org.lwjgl.vulkan.VkStridedDeviceAddressRegionKHR

All Implemented Interfaces:

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

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

Structure specifying a region of device addresses with a stride.

Valid Usage

• If size is not zero, all addresses between deviceAddress and deviceAddress + size - 1 must be in the buffer device address range of the same buffer
• If size is not zero, stride must be less than or equal to the size of the buffer from which deviceAddress was queried

See Also

CmdTraceRaysIndirectKHR, CmdTraceRaysKHR

Layout

 struct VkStridedDeviceAddressRegionKHR {
     VkDeviceAddress deviceAddress();
     VkDeviceSize stride();
     VkDeviceSize size();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkStridedDeviceAddressRegionKHR.Buffer	An array of VkStridedDeviceAddressRegionKHR 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	DEVICEADDRESS	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STRIDE	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
VkStridedDeviceAddressRegionKHR(ByteBuffer container)	Creates a VkStridedDeviceAddressRegionKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkStridedDeviceAddressRegionKHR	calloc()	Returns a new VkStridedDeviceAddressRegionKHR instance allocated with memCalloc.
static VkStridedDeviceAddressRegionKHR.Buffer	calloc(int capacity)	Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with memCalloc.
static VkStridedDeviceAddressRegionKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkStridedDeviceAddressRegionKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkStridedDeviceAddressRegionKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkStridedDeviceAddressRegionKHR	create()	Returns a new VkStridedDeviceAddressRegionKHR instance allocated with BufferUtils.
static VkStridedDeviceAddressRegionKHR.Buffer	create(int capacity)	Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with BufferUtils.
static VkStridedDeviceAddressRegionKHR	create(long address)	Returns a new VkStridedDeviceAddressRegionKHR instance for the specified memory address.
static VkStridedDeviceAddressRegionKHR.Buffer	create(long address, int capacity)	Create a VkStridedDeviceAddressRegionKHR.Buffer instance at the specified memory.
static @Nullable VkStridedDeviceAddressRegionKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkStridedDeviceAddressRegionKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	deviceAddress()	the device address (as returned by the GetBufferDeviceAddress command) at which the region starts, or zero if the region is unused.
VkStridedDeviceAddressRegionKHR	deviceAddress(long value)	Sets the specified value to the deviceAddress() field.
static VkStridedDeviceAddressRegionKHR	malloc()	Returns a new VkStridedDeviceAddressRegionKHR instance allocated with memAlloc.
static VkStridedDeviceAddressRegionKHR.Buffer	malloc(int capacity)	Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with memAlloc.
static VkStridedDeviceAddressRegionKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated on the specified MemoryStack.
static VkStridedDeviceAddressRegionKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkStridedDeviceAddressRegionKHR instance allocated on the specified MemoryStack.
static long	ndeviceAddress(long struct)	Unsafe version of deviceAddress().
static void	ndeviceAddress(long struct, long value)	Unsafe version of deviceAddress.
static long	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, long value)	Unsafe version of size.
static long	nstride(long struct)	Unsafe version of stride().
static void	nstride(long struct, long value)	Unsafe version of stride.
VkStridedDeviceAddressRegionKHR	set(long deviceAddress, long stride, long size)	Initializes this struct with the specified values.
VkStridedDeviceAddressRegionKHR	set(VkStridedDeviceAddressRegionKHR src)	Copies the specified struct data to this struct.
long	size()	the size in bytes of the region starting at deviceAddress.
VkStridedDeviceAddressRegionKHR	size(long value)	Sets the specified value to the size() field.
int	sizeof()
long	stride()	the byte stride between consecutive elements.
VkStridedDeviceAddressRegionKHR	stride(long value)	Sets the specified value to the stride() 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.

DEVICEADDRESS

public static final int DEVICEADDRESS

The struct member offsets.

STRIDE

public static final int STRIDE

The struct member offsets.

SIZE

public static final int SIZE

The struct member offsets.

Constructor Details

VkStridedDeviceAddressRegionKHR

public VkStridedDeviceAddressRegionKHR(ByteBuffer container)

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

deviceAddress

public long deviceAddress()

the device address (as returned by the GetBufferDeviceAddress command) at which the region starts, or zero if the region is unused.

stride

public long stride()

the byte stride between consecutive elements.

size

public long size()

the size in bytes of the region starting at deviceAddress.

deviceAddress

public VkStridedDeviceAddressRegionKHR deviceAddress(long value)

Sets the specified value to the deviceAddress() field.

stride

public VkStridedDeviceAddressRegionKHR stride(long value)

Sets the specified value to the stride() field.

size

public VkStridedDeviceAddressRegionKHR size(long value)

Sets the specified value to the size() field.

set

public VkStridedDeviceAddressRegionKHR set(long deviceAddress,
 long stride,
 long size)

Initializes this struct with the specified values.

set

public VkStridedDeviceAddressRegionKHR set(VkStridedDeviceAddressRegionKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkStridedDeviceAddressRegionKHR malloc()

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

calloc

public static VkStridedDeviceAddressRegionKHR calloc()

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

create

public static VkStridedDeviceAddressRegionKHR create()

Returns a new VkStridedDeviceAddressRegionKHR instance allocated with BufferUtils.

create

public static VkStridedDeviceAddressRegionKHR create(long address)

Returns a new VkStridedDeviceAddressRegionKHR instance for the specified memory address.

createSafe

public static @Nullable VkStridedDeviceAddressRegionKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkStridedDeviceAddressRegionKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkStridedDeviceAddressRegionKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkStridedDeviceAddressRegionKHR.Buffer create(int capacity)

Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkStridedDeviceAddressRegionKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkStridedDeviceAddressRegionKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ndeviceAddress

public static long ndeviceAddress(long struct)

Unsafe version of deviceAddress().

nstride

public static long nstride(long struct)

Unsafe version of stride().

nsize

public static long nsize(long struct)

Unsafe version of size().

ndeviceAddress

public static void ndeviceAddress(long struct,
 long value)

Unsafe version of deviceAddress.

nstride

public static void nstride(long struct,
 long value)

Unsafe version of stride.

nsize

public static void nsize(long struct,
 long value)

Unsafe version of size.