Package org.lwjgl.vulkan

Class VkDescriptorBufferInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDescriptorBufferInfo>

org.lwjgl.vulkan.VkDescriptorBufferInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDescriptorBufferInfo
extends Struct<VkDescriptorBufferInfo>
implements NativeResource

 struct VkDescriptorBufferInfo {
     VkBuffer buffer;
     VkDeviceSize offset;
     VkDeviceSize range;
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFER	The struct member offsets.
static final int	OFFSET	The struct member offsets.
static final int	RANGE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	buffer()
VkDescriptorBufferInfo	buffer(long value)	Sets the specified value to the buffer field.
static VkDescriptorBufferInfo	calloc()	Returns a new VkDescriptorBufferInfo instance allocated with memCalloc.
static VkDescriptorBufferInfo.Buffer	calloc(int capacity)	Returns a new VkDescriptorBufferInfo.Buffer instance allocated with memCalloc.
static VkDescriptorBufferInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorBufferInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorBufferInfo	calloc(MemoryStack stack)	Returns a new VkDescriptorBufferInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDescriptorBufferInfo	create()	Returns a new VkDescriptorBufferInfo instance allocated with BufferUtils.
static VkDescriptorBufferInfo.Buffer	create(int capacity)	Returns a new VkDescriptorBufferInfo.Buffer instance allocated with BufferUtils.
static VkDescriptorBufferInfo	create(long address)	Returns a new VkDescriptorBufferInfo instance for the specified memory address.
static VkDescriptorBufferInfo.Buffer	create(long address, int capacity)	Create a VkDescriptorBufferInfo.Buffer instance at the specified memory.
static @Nullable VkDescriptorBufferInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDescriptorBufferInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDescriptorBufferInfo	malloc()	Returns a new VkDescriptorBufferInfo instance allocated with memAlloc.
static VkDescriptorBufferInfo.Buffer	malloc(int capacity)	Returns a new VkDescriptorBufferInfo.Buffer instance allocated with memAlloc.
static VkDescriptorBufferInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDescriptorBufferInfo.Buffer instance allocated on the specified MemoryStack.
static VkDescriptorBufferInfo	malloc(MemoryStack stack)	Returns a new VkDescriptorBufferInfo instance allocated on the specified MemoryStack.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static long	noffset(long struct)	Unsafe version of offset().
static void	noffset(long struct, long value)	Unsafe version of offset.
static long	nrange(long struct)	Unsafe version of range().
static void	nrange(long struct, long value)	Unsafe version of range.
long	offset()
VkDescriptorBufferInfo	offset(long value)	Sets the specified value to the offset field.
long	range()
VkDescriptorBufferInfo	range(long value)	Sets the specified value to the range field.
VkDescriptorBufferInfo	set(long buffer, long offset, long range)	Initializes this struct with the specified values.
VkDescriptorBufferInfo	set(VkDescriptorBufferInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

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.

BUFFER

public static final int BUFFER

The struct member offsets.

OFFSET

public static final int OFFSET

The struct member offsets.

RANGE

public static final int RANGE

The struct member offsets.

Constructor Details

VkDescriptorBufferInfo

public VkDescriptorBufferInfo(ByteBuffer container)

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

buffer

public long buffer()

Returns:

the value of the buffer field.

offset

public long offset()

Returns:

the value of the offset field.

range

public long range()

Returns:

the value of the range field.

buffer

public VkDescriptorBufferInfo buffer(long value)

Sets the specified value to the buffer field.

offset

public VkDescriptorBufferInfo offset(long value)

Sets the specified value to the offset field.

range

public VkDescriptorBufferInfo range(long value)

Sets the specified value to the range field.

set

public VkDescriptorBufferInfo set(long buffer,
 long offset,
 long range)

Initializes this struct with the specified values.

set

public VkDescriptorBufferInfo set(VkDescriptorBufferInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDescriptorBufferInfo malloc()

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

calloc

public static VkDescriptorBufferInfo calloc()

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

create

public static VkDescriptorBufferInfo create()

Returns a new VkDescriptorBufferInfo instance allocated with BufferUtils.

create

public static VkDescriptorBufferInfo create(long address)

Returns a new VkDescriptorBufferInfo instance for the specified memory address.

createSafe

public static @Nullable VkDescriptorBufferInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorBufferInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDescriptorBufferInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDescriptorBufferInfo.Buffer create(int capacity)

Returns a new VkDescriptorBufferInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDescriptorBufferInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDescriptorBufferInfo malloc(MemoryStack stack)

Returns a new VkDescriptorBufferInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDescriptorBufferInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

noffset

public static long noffset(long struct)

Unsafe version of offset().

nrange

public static long nrange(long struct)

Unsafe version of range().

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.

noffset

public static void noffset(long struct,
 long value)

Unsafe version of offset.

nrange

public static void nrange(long struct,
 long value)

Unsafe version of range.