Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBaseOutStructure

extends Struct<VkBaseOutStructure>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkBaseOutStructure.Buffer

An array of VkBaseOutStructure structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

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
VkBaseOutStructure(long address, ByteBuffer container)

public
VkBaseOutStructure(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkBaseOutStructure
calloc()

Returns a new VkBaseOutStructure instance allocated with memCalloc.

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

Returns a new VkBaseOutStructure.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkBaseOutStructure
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkBaseOutStructure
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 VkBaseOutStructure
create()

Returns a new VkBaseOutStructure instance allocated with BufferUtils.

public static VkBaseOutStructure
create(long address)

Returns a new VkBaseOutStructure instance for the specified memory address.

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

Returns a new VkBaseOutStructure.Buffer instance allocated with BufferUtils.

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

Create a VkBaseOutStructure.Buffer instance at the specified memory.

public static VkBaseOutStructure
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkBaseOutStructure
malloc()

Returns a new VkBaseOutStructure instance allocated with memAlloc.

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

Returns a new VkBaseOutStructure.Buffer instance allocated with memAlloc.

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

Returns a new VkBaseOutStructure instance allocated on the specified MemoryStack.

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

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

public static VkBaseOutStructure
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkBaseOutStructure
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, VkBaseOutStructure value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public VkBaseOutStructure
pNext()

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

public VkBaseOutStructure
pNext(VkBaseOutStructure value)

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

public VkBaseOutStructure
set(int sType, VkBaseOutStructure pNext)

Initializes this struct with the specified values.

public VkBaseOutStructure

Returns:

this struct
set(VkBaseOutStructure
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()

the structure type of the structure being iterated through.

public VkBaseOutStructure
sType(int value)

Sets the specified value to the sType field.

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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

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

VkBaseOutStructureback to summary
protected VkBaseOutStructure(long address, ByteBuffer container)
VkBaseOutStructureback to summary
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 Detail

callocback to summary
public static VkBaseOutStructure calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBaseOutStructure calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkBaseOutStructure callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkBaseOutStructure callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkBaseOutStructure.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkBaseOutStructure.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkBaseOutStructure 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 VkBaseOutStructure create()

Returns a new VkBaseOutStructure instance allocated with BufferUtils.

createback to summary
public static VkBaseOutStructure create(long address)

Returns a new VkBaseOutStructure instance for the specified memory address.

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

Returns a new VkBaseOutStructure.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkBaseOutStructure.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBaseOutStructure createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkBaseOutStructure malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBaseOutStructure malloc(MemoryStack stack)

Returns a new VkBaseOutStructure instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkBaseOutStructure mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkBaseOutStructure mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkBaseOutStructure.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkBaseOutStructure.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
npNextback to summary
public static VkBaseOutStructure npNext(long struct)

Unsafe version of pNext.

Annotations
@Nullable
npNextback to summary
public static void npNext(long struct, VkBaseOutStructure value)

Unsafe version of pNext.

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 VkBaseOutStructure pNext()

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

Annotations
@Nullable
@NativeType:VkBaseOutStructure *
pNextback to summary
public VkBaseOutStructure pNext(VkBaseOutStructure value)

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

setback to summary
public VkBaseOutStructure set(int sType, VkBaseOutStructure pNext)

Initializes this struct with the specified values.

setback to summary
public VkBaseOutStructure set(VkBaseOutStructure src)

Copies the specified struct data to this struct.

Parameters
src:VkBaseOutStructure

the source struct

Returns:VkBaseOutStructure

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()

the structure type of the structure being iterated through.

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

Sets the specified value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkBaseOutStructure.Buffer

extends StructBuffer<VkBaseOutStructure, VkBaseOutStructure.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkBaseOutStructure structs.

Field Summary

Modifier and TypeField and Description
private static final VkBaseOutStructure
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBaseOutStructure.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
protected VkBaseOutStructure
getElementFactory()

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

public VkBaseOutStructure

Returns:

a VkBaseOutStructure view of the struct pointed to by the VkBaseOutStructure#pNext field.
pNext()

public VkBaseOutStructure.Buffer
pNext(VkBaseOutStructure value)

Sets the address of the specified VkBaseOutStructure to the VkBaseOutStructure#pNext field.

protected VkBaseOutStructure.Buffer
self()

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

public int

Returns:

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

public VkBaseOutStructure.Buffer
sType(int value)

Sets the specified value to the VkBaseOutStructure#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBaseOutStructure ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkBaseOutStructure getElementFactory()

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

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

a VkBaseOutStructure view of the struct pointed to by the VkBaseOutStructure#pNext field.

Annotations
@Nullable
@NativeType:VkBaseOutStructure *
pNextback to summary
public VkBaseOutStructure.Buffer pNext(VkBaseOutStructure value)

Sets the address of the specified VkBaseOutStructure to the VkBaseOutStructure#pNext field.

selfback to summary
protected VkBaseOutStructure.Buffer self()

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

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

the value of the VkBaseOutStructure#sType field.

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

Sets the specified value to the VkBaseOutStructure#sType field.