Package org.lwjgl.vulkan

Class VkBaseOutStructure

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBaseOutStructure>

org.lwjgl.vulkan.VkBaseOutStructure

All Implemented Interfaces:

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

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

Base structure for a read-only pointer chain.

Description

VkBaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

See Also

VkBaseOutStructure, GetPipelinePropertiesEXT

Layout

 struct VkBaseOutStructure {
     VkStructureType sType();
     VkBaseOutStructure * pNext();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBaseOutStructure.Buffer	An array of VkBaseOutStructure 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
VkBaseOutStructure(ByteBuffer container)	Creates a VkBaseOutStructure instance at the current position of the specified ByteBuffer container.

Method Summary

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

VkBaseOutStructure

public VkBaseOutStructure(ByteBuffer container)

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

sType

public int sType()

the structure type of the structure being iterated through.

pNext

public @Nullable VkBaseOutStructure pNext()

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

sType

public VkBaseOutStructure sType(int value)

Sets the specified value to the sType() field.

pNext

public VkBaseOutStructure pNext(@Nullable VkBaseOutStructure value)

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

set

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

Initializes this struct with the specified values.

set

public VkBaseOutStructure set(VkBaseOutStructure src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBaseOutStructure malloc()

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

calloc

public static VkBaseOutStructure calloc()

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

create

public static VkBaseOutStructure create()

Returns a new VkBaseOutStructure instance allocated with BufferUtils.

create

public static VkBaseOutStructure create(long address)

Returns a new VkBaseOutStructure instance for the specified memory address.

createSafe

public static @Nullable VkBaseOutStructure createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBaseOutStructure.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBaseOutStructure.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBaseOutStructure.Buffer create(int capacity)

Returns a new VkBaseOutStructure.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBaseOutStructure.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkBaseOutStructure mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkBaseOutStructure callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkBaseOutStructure.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 VkBaseOutStructure.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 VkBaseOutStructure malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkBaseOutStructure instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkBaseOutStructure.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 VkBaseOutStructure 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 VkBaseOutStructure value)

Unsafe version of pNext.