Class VkDeviceOrHostAddressConstKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceOrHostAddressConstKHR>

org.lwjgl.vulkan.VkDeviceOrHostAddressConstKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDeviceOrHostAddressConstKHR
extends Struct<VkDeviceOrHostAddressConstKHR>
implements NativeResource

union VkDeviceOrHostAddressConstKHR {
    VkDeviceAddress deviceAddress;
    void const * hostAddress;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

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	HOSTADDRESS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceOrHostAddressConstKHR	calloc()	Returns a new VkDeviceOrHostAddressConstKHR instance allocated with memCalloc.
static VkDeviceOrHostAddressConstKHR.Buffer	calloc(int capacity)	Returns a new VkDeviceOrHostAddressConstKHR.Buffer instance allocated with memCalloc.
static VkDeviceOrHostAddressConstKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDeviceOrHostAddressConstKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceOrHostAddressConstKHR	calloc(MemoryStack stack)	Returns a new VkDeviceOrHostAddressConstKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceOrHostAddressConstKHR	create()	Returns a new VkDeviceOrHostAddressConstKHR instance allocated with BufferUtils.
static VkDeviceOrHostAddressConstKHR.Buffer	create(int capacity)	Returns a new VkDeviceOrHostAddressConstKHR.Buffer instance allocated with BufferUtils.
static VkDeviceOrHostAddressConstKHR	create(long address)	Returns a new VkDeviceOrHostAddressConstKHR instance for the specified memory address.
static VkDeviceOrHostAddressConstKHR.Buffer	create(long address, int capacity)	Create a VkDeviceOrHostAddressConstKHR.Buffer instance at the specified memory.
static @Nullable VkDeviceOrHostAddressConstKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceOrHostAddressConstKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	deviceAddress()
VkDeviceOrHostAddressConstKHR	deviceAddress(long value)	Sets the specified value to the deviceAddress field.
long	hostAddress()
VkDeviceOrHostAddressConstKHR	hostAddress(long value)	Sets the specified value to the hostAddress field.
static VkDeviceOrHostAddressConstKHR	malloc()	Returns a new VkDeviceOrHostAddressConstKHR instance allocated with memAlloc.
static VkDeviceOrHostAddressConstKHR.Buffer	malloc(int capacity)	Returns a new VkDeviceOrHostAddressConstKHR.Buffer instance allocated with memAlloc.
static VkDeviceOrHostAddressConstKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDeviceOrHostAddressConstKHR.Buffer instance allocated on the specified MemoryStack.
static VkDeviceOrHostAddressConstKHR	malloc(MemoryStack stack)	Returns a new VkDeviceOrHostAddressConstKHR 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	nhostAddress(long struct)	Unsafe version of hostAddress().
static void	nhostAddress(long struct, long value)	Unsafe version of hostAddress.
VkDeviceOrHostAddressConstKHR	set(VkDeviceOrHostAddressConstKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

HOSTADDRESS

public static final int HOSTADDRESS

The struct member offsets.

Constructor Details

VkDeviceOrHostAddressConstKHR

public VkDeviceOrHostAddressConstKHR(ByteBuffer container)

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

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDeviceOrHostAddressConstKHR>

deviceAddress

@NativeType("VkDeviceAddress")
public long deviceAddress()

Returns:

the value of the deviceAddress field.

hostAddress

@NativeType("void const *")
public long hostAddress()

Returns:

the value of the hostAddress field.

deviceAddress

public VkDeviceOrHostAddressConstKHR deviceAddress(@NativeType("VkDeviceAddress")
 long value)

Sets the specified value to the deviceAddress field.

hostAddress

public VkDeviceOrHostAddressConstKHR hostAddress(@NativeType("void const *")
 long value)

Sets the specified value to the hostAddress field.

set

public VkDeviceOrHostAddressConstKHR set(VkDeviceOrHostAddressConstKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceOrHostAddressConstKHR malloc()

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

calloc

public static VkDeviceOrHostAddressConstKHR calloc()

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

create

public static VkDeviceOrHostAddressConstKHR create()

Returns a new VkDeviceOrHostAddressConstKHR instance allocated with BufferUtils.

create

public static VkDeviceOrHostAddressConstKHR create(long address)

Returns a new VkDeviceOrHostAddressConstKHR instance for the specified memory address.

createSafe

public static @Nullable VkDeviceOrHostAddressConstKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceOrHostAddressConstKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceOrHostAddressConstKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceOrHostAddressConstKHR.Buffer create(int capacity)

Returns a new VkDeviceOrHostAddressConstKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceOrHostAddressConstKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDeviceOrHostAddressConstKHR malloc(MemoryStack stack)

Returns a new VkDeviceOrHostAddressConstKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDeviceOrHostAddressConstKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nhostAddress

public static long nhostAddress(long struct)

Unsafe version of hostAddress().

ndeviceAddress

public static void ndeviceAddress(long struct,
 long value)

Unsafe version of deviceAddress.

nhostAddress

public static void nhostAddress(long struct,
 long value)

Unsafe version of hostAddress.