Package org.lwjgl.vulkan

Class VkBaseInStructure

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBaseInStructure>

org.lwjgl.vulkan.VkBaseInStructure

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkBaseInStructure
extends org.lwjgl.system.Struct<VkBaseInStructure>
implements org.lwjgl.system.NativeResource

Base structure for a read-only pointer chain.

Description

VkBaseInStructure can be used to facilitate iterating through a read-only structure pointer chain.

See Also

VkBaseInStructure

Layout

 struct VkBaseInStructure {
     VkStructureType sType();
     VkBaseInStructure const * pNext();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBaseInStructure	calloc()	Returns a new VkBaseInStructure instance allocated with memCalloc.
static VkBaseInStructure.Buffer	calloc(int capacity)	Returns a new VkBaseInStructure.Buffer instance allocated with memCalloc.
static VkBaseInStructure.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBaseInStructure.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBaseInStructure	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBaseInStructure instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBaseInStructure	callocStack()	Deprecated.
static VkBaseInStructure.Buffer	callocStack(int capacity)	Deprecated.
static VkBaseInStructure.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkBaseInStructure	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkBaseInStructure	create()	Returns a new VkBaseInStructure instance allocated with BufferUtils.
static VkBaseInStructure.Buffer	create(int capacity)	Returns a new VkBaseInStructure.Buffer instance allocated with BufferUtils.
static VkBaseInStructure	create(long address)	Returns a new VkBaseInStructure instance for the specified memory address.
static VkBaseInStructure.Buffer	create(long address, int capacity)	Create a VkBaseInStructure.Buffer instance at the specified memory.
static @Nullable VkBaseInStructure	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBaseInStructure.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkBaseInStructure	malloc()	Returns a new VkBaseInStructure instance allocated with memAlloc.
static VkBaseInStructure.Buffer	malloc(int capacity)	Returns a new VkBaseInStructure.Buffer instance allocated with memAlloc.
static VkBaseInStructure.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkBaseInStructure.Buffer instance allocated on the specified MemoryStack.
static VkBaseInStructure	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkBaseInStructure instance allocated on the specified MemoryStack.
static VkBaseInStructure	mallocStack()	Deprecated.
static VkBaseInStructure.Buffer	mallocStack(int capacity)	Deprecated.
static VkBaseInStructure.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkBaseInStructure	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static @Nullable VkBaseInStructure	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, @Nullable VkBaseInStructure value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
@Nullable VkBaseInStructure	pNext()	NULL or a pointer to the next structure in a structure chain.
VkBaseInStructure	pNext(@Nullable VkBaseInStructure value)	Sets the address of the specified VkBaseInStructure to the pNext() field.
VkBaseInStructure	set(int sType, @Nullable VkBaseInStructure pNext)	Initializes this struct with the specified values.
VkBaseInStructure	set(VkBaseInStructure src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	the structure type of the structure being iterated through.
VkBaseInStructure	sType(int value)	Sets the specified value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

Constructor Details

VkBaseInStructure

public VkBaseInStructure(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<VkBaseInStructure>

sType

public int sType()

the structure type of the structure being iterated through.

pNext

public @Nullable VkBaseInStructure pNext()

NULL or a pointer to the next structure in a structure chain.

sType

public VkBaseInStructure sType(int value)

Sets the specified value to the sType() field.

pNext

public VkBaseInStructure pNext(@Nullable VkBaseInStructure value)

Sets the address of the specified VkBaseInStructure to the pNext() field.

set

public VkBaseInStructure set(int sType,
 @Nullable VkBaseInStructure pNext)

Initializes this struct with the specified values.

set

public VkBaseInStructure set(VkBaseInStructure src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBaseInStructure malloc()

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

calloc

public static VkBaseInStructure calloc()

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

create

public static VkBaseInStructure create()

Returns a new VkBaseInStructure instance allocated with BufferUtils.

create

public static VkBaseInStructure create(long address)

Returns a new VkBaseInStructure instance for the specified memory address.

createSafe

public static @Nullable VkBaseInStructure createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBaseInStructure.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBaseInStructure.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBaseInStructure.Buffer create(int capacity)

Returns a new VkBaseInStructure.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBaseInStructure.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkBaseInStructure mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkBaseInStructure callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkBaseInStructure mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkBaseInStructure callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkBaseInStructure.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkBaseInStructure.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkBaseInStructure.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkBaseInStructure.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkBaseInStructure malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkBaseInStructure instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBaseInStructure calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkBaseInStructure.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkBaseInStructure.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static @Nullable VkBaseInStructure npNext(long struct)

Unsafe version of pNext().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 @Nullable VkBaseInStructure value)

Unsafe version of pNext.