Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDescriptorAddressInfoEXT

extends Struct<VkDescriptorAddressInfoEXT>
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 descriptor buffer address info.
Valid Usage
Valid Usage (Implicit)

If the nullDescriptor feature is enabled, address can be zero. Loads from a null descriptor return zero values and stores and atomics to a null descriptor are discarded.

See Also

VkDescriptorDataEXT

Layout


struct VkDescriptorAddressInfoEXT {
    VkStructureType sType;
    void * pNext;
    VkDeviceAddress address;
    VkDeviceSize range;
    VkFormat format;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ADDRESS

Hides org.lwjgl.system.Pointer.Default.ADDRESS.

The struct member offsets.
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FORMAT

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
RANGE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkDescriptorAddressInfoEXT(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
address$()

either 0 or a device address at an offset in a buffer, where the base address can be queried from GetBufferDeviceAddress.

public VkDescriptorAddressInfoEXT
address$(long value)

Sets the specified value to the address$ field.

public static VkDescriptorAddressInfoEXT
calloc()

Returns a new VkDescriptorAddressInfoEXT instance allocated with memCalloc.

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

Returns a new VkDescriptorAddressInfoEXT.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkDescriptorAddressInfoEXT instance allocated with BufferUtils.

public static VkDescriptorAddressInfoEXT
create(long address)

Returns a new VkDescriptorAddressInfoEXT instance for the specified memory address.

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

Returns a new VkDescriptorAddressInfoEXT.Buffer instance allocated with BufferUtils.

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

Create a VkDescriptorAddressInfoEXT.Buffer instance at the specified memory.

public static VkDescriptorAddressInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
format()

the format of the data elements in the buffer view and is ignored for buffers.

public VkDescriptorAddressInfoEXT
format(int value)

Sets the specified value to the format field.

public static VkDescriptorAddressInfoEXT
malloc()

Returns a new VkDescriptorAddressInfoEXT instance allocated with memAlloc.

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

Returns a new VkDescriptorAddressInfoEXT.Buffer instance allocated with memAlloc.

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

Returns a new VkDescriptorAddressInfoEXT instance allocated on the specified MemoryStack.

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

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

public static long
naddress$(long struct)

Unsafe version of address$.

public static void
naddress$(long struct, long value)

Unsafe version of address$.

public static int
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nrange(long struct)

Unsafe version of range.

public static void
nrange(long struct, long value)

Unsafe version of range.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDescriptorAddressInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public long
range()

the size in bytes of the buffer or buffer view used by the descriptor.

public VkDescriptorAddressInfoEXT
range(long value)

Sets the specified value to the range field.

public VkDescriptorAddressInfoEXT
set(int sType, long pNext, long address$, long range, int format)

Initializes this struct with the specified values.

public VkDescriptorAddressInfoEXT

Returns:

this struct
set
(VkDescriptorAddressInfoEXT
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).
public int
sType()

a VkStructureType value identifying this structure.

public VkDescriptorAddressInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkDescriptorAddressInfoEXT
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

ADDRESSback to summary
public static final int ADDRESS

Hides org.lwjgl.system.Pointer.Default.ADDRESS.

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

RANGEback to summary
public static final int RANGE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDescriptorAddressInfoEXTback to summary
protected VkDescriptorAddressInfoEXT(long address, ByteBuffer container)
VkDescriptorAddressInfoEXTback to summary
public VkDescriptorAddressInfoEXT(ByteBuffer container)

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

address$back to summary
public long address$()

either 0 or a device address at an offset in a buffer, where the base address can be queried from GetBufferDeviceAddress.

Annotations
@NativeType:VkDeviceAddress
address$back to summary
public VkDescriptorAddressInfoEXT address$(long value)

Sets the specified value to the address$ field.

callocback to summary
public static VkDescriptorAddressInfoEXT calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDescriptorAddressInfoEXT calloc(MemoryStack stack)

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

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

Returns a new VkDescriptorAddressInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkDescriptorAddressInfoEXT create(long address)

Returns a new VkDescriptorAddressInfoEXT instance for the specified memory address.

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

Returns a new VkDescriptorAddressInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDescriptorAddressInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDescriptorAddressInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
formatback to summary
public int format()

the format of the data elements in the buffer view and is ignored for buffers.

Annotations
@NativeType:VkFormat
formatback to summary
public VkDescriptorAddressInfoEXT format(int value)

Sets the specified value to the format field.

mallocback to summary
public static VkDescriptorAddressInfoEXT malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDescriptorAddressInfoEXT malloc(MemoryStack stack)

Returns a new VkDescriptorAddressInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

naddress$back to summary
public static long naddress$(long struct)

Unsafe version of address$.

naddress$back to summary
public static void naddress$(long struct, long value)

Unsafe version of address$.

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nformatback to summary
public static void nformat(long struct, int value)

Unsafe version of format.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nrangeback to summary
public static long nrange(long struct)

Unsafe version of range.

nrangeback to summary
public static void nrange(long struct, long value)

Unsafe version of range.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkDescriptorAddressInfoEXT pNext(long value)

Sets the specified value to the pNext field.

rangeback to summary
public long range()

the size in bytes of the buffer or buffer view used by the descriptor.

Annotations
@NativeType:VkDeviceSize
rangeback to summary
public VkDescriptorAddressInfoEXT range(long value)

Sets the specified value to the range field.

setback to summary
public VkDescriptorAddressInfoEXT set(int sType, long pNext, long address$, long range, int format)

Initializes this struct with the specified values.

setback to summary
public VkDescriptorAddressInfoEXT set(VkDescriptorAddressInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkDescriptorAddressInfoEXT

the source struct

Returns:VkDescriptorAddressInfoEXT

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDescriptorAddressInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDescriptorAddressInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_ADDRESS_INFO_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDescriptorAddressInfoEXT.Buffer

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

An array of VkDescriptorAddressInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkDescriptorAddressInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDescriptorAddressInfoEXT.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 VkDescriptorAddressInfoEXT#address$ field.
address$
()

public VkDescriptorAddressInfoEXT.Buffer
address$(long value)

Sets the specified value to the VkDescriptorAddressInfoEXT#address$ field.

public int

Returns:

the value of the VkDescriptorAddressInfoEXT#format field.
format
()

public VkDescriptorAddressInfoEXT.Buffer
format(int value)

Sets the specified value to the VkDescriptorAddressInfoEXT#format field.

protected VkDescriptorAddressInfoEXT
public long

Returns:

the value of the VkDescriptorAddressInfoEXT#pNext field.
pNext
()

public VkDescriptorAddressInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkDescriptorAddressInfoEXT#pNext field.

public long

Returns:

the value of the VkDescriptorAddressInfoEXT#range field.
range
()

public VkDescriptorAddressInfoEXT.Buffer
range(long value)

Sets the specified value to the VkDescriptorAddressInfoEXT#range field.

protected VkDescriptorAddressInfoEXT.Buffer
public int

Returns:

the value of the VkDescriptorAddressInfoEXT#sType field.
sType
()

public VkDescriptorAddressInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkDescriptorAddressInfoEXT#sType field.

public VkDescriptorAddressInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDescriptorAddressInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

address$back to summary
public long address$()
Returns:long

the value of the VkDescriptorAddressInfoEXT#address$ field.

Annotations
@NativeType:VkDeviceAddress
address$back to summary
public VkDescriptorAddressInfoEXT.Buffer address$(long value)

Sets the specified value to the VkDescriptorAddressInfoEXT#address$ field.

formatback to summary
public int format()
Returns:int

the value of the VkDescriptorAddressInfoEXT#format field.

Annotations
@NativeType:VkFormat
formatback to summary
public VkDescriptorAddressInfoEXT.Buffer format(int value)

Sets the specified value to the VkDescriptorAddressInfoEXT#format field.

getElementFactoryback to summary
protected VkDescriptorAddressInfoEXT getElementFactory()

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

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkDescriptorAddressInfoEXT#pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkDescriptorAddressInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkDescriptorAddressInfoEXT#pNext field.

rangeback to summary
public long range()
Returns:long

the value of the VkDescriptorAddressInfoEXT#range field.

Annotations
@NativeType:VkDeviceSize
rangeback to summary
public VkDescriptorAddressInfoEXT.Buffer range(long value)

Sets the specified value to the VkDescriptorAddressInfoEXT#range field.

selfback to summary
protected VkDescriptorAddressInfoEXT.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDescriptorAddressInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDescriptorAddressInfoEXT.Buffer sType(int value)

Sets the specified value to the VkDescriptorAddressInfoEXT#sType field.

sType$Defaultback to summary
public VkDescriptorAddressInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DESCRIPTOR_ADDRESS_INFO_EXT value to the VkDescriptorAddressInfoEXT#sType field.