Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceOrHostAddressKHR

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

Union specifying a device or host address.
See Also

VkAccelerationStructureBuildGeometryInfoKHR, VkCopyAccelerationStructureToMemoryInfoKHR, VkCopyMicromapToMemoryInfoEXT, VkMicromapBuildInfoEXT

Layout


union VkDeviceOrHostAddressKHR {
    VkDeviceAddress deviceAddress;
    void * hostAddress;
}

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
HOSTADDRESS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDeviceOrHostAddressKHR(long address, ByteBuffer container)

public
VkDeviceOrHostAddressKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceOrHostAddressKHR
calloc()

Returns a new VkDeviceOrHostAddressKHR instance allocated with memCalloc.

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

Returns a new VkDeviceOrHostAddressKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkDeviceOrHostAddressKHR instance allocated with BufferUtils.

public static VkDeviceOrHostAddressKHR
create(long address)

Returns a new VkDeviceOrHostAddressKHR instance for the specified memory address.

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

Returns a new VkDeviceOrHostAddressKHR.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceOrHostAddressKHR.Buffer instance at the specified memory.

public static VkDeviceOrHostAddressKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
deviceAddress()

a buffer device address as returned by the GetBufferDeviceAddressKHR command.

public VkDeviceOrHostAddressKHR
deviceAddress(long value)

Sets the specified value to the deviceAddress field.

public long
hostAddress()

a host memory address.

public VkDeviceOrHostAddressKHR
hostAddress(long value)

Sets the specified value to the hostAddress field.

public static VkDeviceOrHostAddressKHR
malloc()

Returns a new VkDeviceOrHostAddressKHR instance allocated with memAlloc.

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

Returns a new VkDeviceOrHostAddressKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceOrHostAddressKHR instance allocated on the specified MemoryStack.

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

Returns a new VkDeviceOrHostAddressKHR.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
nhostAddress(long struct)

Unsafe version of hostAddress.

public static void
nhostAddress(long struct, long value)

Unsafe version of hostAddress.

public VkDeviceOrHostAddressKHR

Returns:

this struct
set
(VkDeviceOrHostAddressKHR
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).
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.

HOSTADDRESSback to summary
public static final int HOSTADDRESS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkDeviceOrHostAddressKHRback to summary
protected VkDeviceOrHostAddressKHR(long address, ByteBuffer container)
VkDeviceOrHostAddressKHRback to summary
public VkDeviceOrHostAddressKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceOrHostAddressKHR calloc(MemoryStack stack)

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

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

Returns a new VkDeviceOrHostAddressKHR instance allocated with BufferUtils.

createback to summary
public static VkDeviceOrHostAddressKHR create(long address)

Returns a new VkDeviceOrHostAddressKHR instance for the specified memory address.

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

Returns a new VkDeviceOrHostAddressKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceOrHostAddressKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceOrHostAddressKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceAddressback to summary
public long deviceAddress()

a buffer device address as returned by the GetBufferDeviceAddressKHR command.

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

Sets the specified value to the deviceAddress field.

hostAddressback to summary
public long hostAddress()

a host memory address.

Annotations
@NativeType:void *
hostAddressback to summary
public VkDeviceOrHostAddressKHR hostAddress(long value)

Sets the specified value to the hostAddress field.

mallocback to summary
public static VkDeviceOrHostAddressKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceOrHostAddressKHR malloc(MemoryStack stack)

Returns a new VkDeviceOrHostAddressKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

nhostAddressback to summary
public static long nhostAddress(long struct)

Unsafe version of hostAddress.

nhostAddressback to summary
public static void nhostAddress(long struct, long value)

Unsafe version of hostAddress.

setback to summary
public VkDeviceOrHostAddressKHR set(VkDeviceOrHostAddressKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceOrHostAddressKHR

the source struct

Returns:VkDeviceOrHostAddressKHR

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
org.lwjgl.vulkan back to summary

public Class VkDeviceOrHostAddressKHR.Buffer

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

An array of VkDeviceOrHostAddressKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceOrHostAddressKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkDeviceOrHostAddressKHR#deviceAddress field.
deviceAddress
()

public VkDeviceOrHostAddressKHR.Buffer
deviceAddress(long value)

Sets the specified value to the VkDeviceOrHostAddressKHR#deviceAddress field.

protected VkDeviceOrHostAddressKHR
public long

Returns:

the value of the VkDeviceOrHostAddressKHR#hostAddress field.
hostAddress
()

public VkDeviceOrHostAddressKHR.Buffer
hostAddress(long value)

Sets the specified value to the VkDeviceOrHostAddressKHR#hostAddress field.

protected VkDeviceOrHostAddressKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceOrHostAddressKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceOrHostAddressKHR.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 VkDeviceOrHostAddressKHR#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 VkDeviceOrHostAddressKHR#deviceAddress field.

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

Sets the specified value to the VkDeviceOrHostAddressKHR#deviceAddress field.

getElementFactoryback to summary
protected VkDeviceOrHostAddressKHR getElementFactory()

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

Annotations
@Override
hostAddressback to summary
public long hostAddress()
Returns:long

the value of the VkDeviceOrHostAddressKHR#hostAddress field.

Annotations
@NativeType:void *
hostAddressback to summary
public VkDeviceOrHostAddressKHR.Buffer hostAddress(long value)

Sets the specified value to the VkDeviceOrHostAddressKHR#hostAddress field.

selfback to summary
protected VkDeviceOrHostAddressKHR.Buffer self()

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

Annotations
@Override