Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkStridedDeviceAddressRegionKHR

extends Struct<VkStridedDeviceAddressRegionKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying a region of device addresses with a stride.
Valid Usage
See Also

CmdTraceRaysIndirectKHR, CmdTraceRaysKHR

Layout


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

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
DEVICEADDRESS

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STRIDE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkStridedDeviceAddressRegionKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkStridedDeviceAddressRegionKHR
calloc()

Returns a new VkStridedDeviceAddressRegionKHR instance allocated with memCalloc.

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

Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkStridedDeviceAddressRegionKHR instance allocated with BufferUtils.

public static VkStridedDeviceAddressRegionKHR
create(long address)

Returns a new VkStridedDeviceAddressRegionKHR instance for the specified memory address.

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

Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with BufferUtils.

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

Create a VkStridedDeviceAddressRegionKHR.Buffer instance at the specified memory.

public static VkStridedDeviceAddressRegionKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
deviceAddress()

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

public VkStridedDeviceAddressRegionKHR
deviceAddress(long value)

Sets the specified value to the deviceAddress field.

public static VkStridedDeviceAddressRegionKHR
malloc()

Returns a new VkStridedDeviceAddressRegionKHR instance allocated with memAlloc.

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

Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkStridedDeviceAddressRegionKHR instance allocated on the specified MemoryStack.

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

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

public static long
ndeviceAddress(long struct)

Unsafe version of deviceAddress.

public static void
ndeviceAddress(long struct, long value)

Unsafe version of deviceAddress.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public static long
nstride(long struct)

Unsafe version of stride.

public static void
nstride(long struct, long value)

Unsafe version of stride.

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

Initializes this struct with the specified values.

public VkStridedDeviceAddressRegionKHR

Returns:

this struct
set
(VkStridedDeviceAddressRegionKHR
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

the size in bytes of the region starting at deviceAddress.

public VkStridedDeviceAddressRegionKHR
size(long value)

Sets the specified value to the size field.

public int
sizeof()

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

Returns sizeof(struct).
public long
stride()

the byte stride between consecutive elements.

public VkStridedDeviceAddressRegionKHR
stride(long value)

Sets the specified value to the stride 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.

DEVICEADDRESSback to summary
public static final int DEVICEADDRESS

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STRIDEback to summary
public static final int STRIDE

The struct member offsets.

Constructor Detail

VkStridedDeviceAddressRegionKHRback to summary
protected VkStridedDeviceAddressRegionKHR(long address, ByteBuffer container)
VkStridedDeviceAddressRegionKHRback to summary
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 Detail

callocback to summary
public static VkStridedDeviceAddressRegionKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkStridedDeviceAddressRegionKHR calloc(MemoryStack stack)

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

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

Returns a new VkStridedDeviceAddressRegionKHR instance allocated with BufferUtils.

createback to summary
public static VkStridedDeviceAddressRegionKHR create(long address)

Returns a new VkStridedDeviceAddressRegionKHR instance for the specified memory address.

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

Returns a new VkStridedDeviceAddressRegionKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkStridedDeviceAddressRegionKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkStridedDeviceAddressRegionKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceAddressback to summary
public long deviceAddress()

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

Annotations
@NativeType:VkDeviceAddress
deviceAddressback to summary
public VkStridedDeviceAddressRegionKHR deviceAddress(long value)

Sets the specified value to the deviceAddress field.

mallocback to summary
public static VkStridedDeviceAddressRegionKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkStridedDeviceAddressRegionKHR malloc(MemoryStack stack)

Returns a new VkStridedDeviceAddressRegionKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ndeviceAddressback to summary
public static long ndeviceAddress(long struct)

Unsafe version of deviceAddress.

ndeviceAddressback to summary
public static void ndeviceAddress(long struct, long value)

Unsafe version of deviceAddress.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

Unsafe version of size.

nstrideback to summary
public static long nstride(long struct)

Unsafe version of stride.

nstrideback to summary
public static void nstride(long struct, long value)

Unsafe version of stride.

setback to summary
public VkStridedDeviceAddressRegionKHR set(long deviceAddress, long stride, long size)

Initializes this struct with the specified values.

setback to summary
public VkStridedDeviceAddressRegionKHR set(VkStridedDeviceAddressRegionKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkStridedDeviceAddressRegionKHR

the source struct

Returns:VkStridedDeviceAddressRegionKHR

this struct

sizeback to summary
public long size()

the size in bytes of the region starting at deviceAddress.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkStridedDeviceAddressRegionKHR size(long value)

Sets the specified value to the size field.

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
strideback to summary
public long stride()

the byte stride between consecutive elements.

Annotations
@NativeType:VkDeviceSize
strideback to summary
public VkStridedDeviceAddressRegionKHR stride(long value)

Sets the specified value to the stride field.

org.lwjgl.vulkan back to summary

public Class VkStridedDeviceAddressRegionKHR.Buffer

extends StructBuffer<VkStridedDeviceAddressRegionKHR, VkStridedDeviceAddressRegionKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkStridedDeviceAddressRegionKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkStridedDeviceAddressRegionKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkStridedDeviceAddressRegionKHR.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
public long
public VkStridedDeviceAddressRegionKHR.Buffer
deviceAddress(long value)

Sets the specified value to the VkStridedDeviceAddressRegionKHR#deviceAddress field.

protected VkStridedDeviceAddressRegionKHR
protected VkStridedDeviceAddressRegionKHR.Buffer
public long

Returns:

the value of the VkStridedDeviceAddressRegionKHR#size field.
size
()

public VkStridedDeviceAddressRegionKHR.Buffer
size(long value)

Sets the specified value to the VkStridedDeviceAddressRegionKHR#size field.

public long

Returns:

the value of the VkStridedDeviceAddressRegionKHR#stride field.
stride
()

public VkStridedDeviceAddressRegionKHR.Buffer
stride(long value)

Sets the specified value to the VkStridedDeviceAddressRegionKHR#stride field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkStridedDeviceAddressRegionKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

deviceAddressback to summary
public long deviceAddress()
Returns:long

the value of the VkStridedDeviceAddressRegionKHR#deviceAddress field.

Annotations
@NativeType:VkDeviceAddress
deviceAddressback to summary
public VkStridedDeviceAddressRegionKHR.Buffer deviceAddress(long value)

Sets the specified value to the VkStridedDeviceAddressRegionKHR#deviceAddress field.

getElementFactoryback to summary
protected VkStridedDeviceAddressRegionKHR getElementFactory()

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

Annotations
@Override
selfback to summary
protected VkStridedDeviceAddressRegionKHR.Buffer self()

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

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkStridedDeviceAddressRegionKHR#size field.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkStridedDeviceAddressRegionKHR.Buffer size(long value)

Sets the specified value to the VkStridedDeviceAddressRegionKHR#size field.

strideback to summary
public long stride()
Returns:long

the value of the VkStridedDeviceAddressRegionKHR#stride field.

Annotations
@NativeType:VkDeviceSize
strideback to summary
public VkStridedDeviceAddressRegionKHR.Buffer stride(long value)

Sets the specified value to the VkStridedDeviceAddressRegionKHR#stride field.