Package org.lwjgl.vulkan
Class VkBaseOutStructure
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBaseOutStructure
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkBaseOutStructure extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceBase structure for a read-only pointer chain.Description
VkBaseOutStructurecan be used to facilitate iterating through a structure pointer chain that returns data back to the application.See Also
Member documentation
sType– the structure type of the structure being iterated through.pNext–NULLor a pointer to the next structure in a structure chain.
Layout
struct VkBaseOutStructure { VkStructureType sType;VkBaseOutStructure* pNext; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkBaseOutStructure.BufferAn array ofVkBaseOutStructurestructs.
-
Constructor Summary
Constructors Constructor Description VkBaseOutStructure(java.nio.ByteBuffer container)Creates aVkBaseOutStructureinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkBaseOutStructurecalloc()Returns a newVkBaseOutStructureinstance allocated withmemCalloc.static VkBaseOutStructure.Buffercalloc(int capacity)Returns a newVkBaseOutStructure.Bufferinstance allocated withmemCalloc.static VkBaseOutStructurecallocStack()Returns a newVkBaseOutStructureinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkBaseOutStructure.BuffercallocStack(int capacity)Returns a newVkBaseOutStructure.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkBaseOutStructure.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBaseOutStructure.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBaseOutStructurecallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkBaseOutStructureinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBaseOutStructurecreate()Returns a newVkBaseOutStructureinstance allocated withBufferUtils.static VkBaseOutStructure.Buffercreate(int capacity)Returns a newVkBaseOutStructure.Bufferinstance allocated withBufferUtils.static VkBaseOutStructurecreate(long address)Returns a newVkBaseOutStructureinstance for the specified memory address.static VkBaseOutStructure.Buffercreate(long address, int capacity)Create aVkBaseOutStructure.Bufferinstance at the specified memory.static VkBaseOutStructurecreateSafe(long address)static VkBaseOutStructure.BuffercreateSafe(long address, int capacity)static VkBaseOutStructuremalloc()Returns a newVkBaseOutStructureinstance allocated withmemAlloc.static VkBaseOutStructure.Buffermalloc(int capacity)Returns a newVkBaseOutStructure.Bufferinstance allocated withmemAlloc.static VkBaseOutStructuremallocStack()Returns a newVkBaseOutStructureinstance allocated on the thread-localMemoryStack.static VkBaseOutStructure.BuffermallocStack(int capacity)Returns a newVkBaseOutStructure.Bufferinstance allocated on the thread-localMemoryStack.static VkBaseOutStructure.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBaseOutStructure.Bufferinstance allocated on the specifiedMemoryStack.static VkBaseOutStructuremallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkBaseOutStructureinstance allocated on the specifiedMemoryStack.static VkBaseOutStructurenpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, VkBaseOutStructure value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.VkBaseOutStructurepNext()Returns aVkBaseOutStructureview of the struct pointed to by thepNextfield.VkBaseOutStructurepNext(VkBaseOutStructure value)Sets the address of the specifiedVkBaseOutStructureto thepNextfield.VkBaseOutStructureset(int sType, VkBaseOutStructure pNext)Initializes this struct with the specified values.VkBaseOutStructureset(VkBaseOutStructure src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkBaseOutStructuresType(int value)Sets the specified value to thesTypefield.
-
-
-
Constructor Detail
-
VkBaseOutStructure
public VkBaseOutStructure(java.nio.ByteBuffer container)
Creates aVkBaseOutStructureinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
@Nullable public VkBaseOutStructure pNext()
Returns aVkBaseOutStructureview of the struct pointed to by thepNextfield.
-
sType
public VkBaseOutStructure sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkBaseOutStructure pNext(@Nullable VkBaseOutStructure value)
Sets the address of the specifiedVkBaseOutStructureto thepNextfield.
-
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 newVkBaseOutStructureinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkBaseOutStructure calloc()
Returns a newVkBaseOutStructureinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkBaseOutStructure create()
Returns a newVkBaseOutStructureinstance allocated withBufferUtils.
-
create
public static VkBaseOutStructure create(long address)
Returns a newVkBaseOutStructureinstance for the specified memory address.
-
createSafe
@Nullable public static VkBaseOutStructure createSafe(long address)
-
malloc
public static VkBaseOutStructure.Buffer malloc(int capacity)
Returns a newVkBaseOutStructure.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkBaseOutStructure.Buffer calloc(int capacity)
Returns a newVkBaseOutStructure.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkBaseOutStructure.Buffer create(int capacity)
Returns a newVkBaseOutStructure.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkBaseOutStructure.Buffer create(long address, int capacity)
Create aVkBaseOutStructure.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkBaseOutStructure.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkBaseOutStructure mallocStack()
Returns a newVkBaseOutStructureinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkBaseOutStructure callocStack()
Returns a newVkBaseOutStructureinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkBaseOutStructure mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBaseOutStructureinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkBaseOutStructure callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkBaseOutStructureinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkBaseOutStructure.Buffer mallocStack(int capacity)
Returns a newVkBaseOutStructure.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkBaseOutStructure.Buffer callocStack(int capacity)
Returns a newVkBaseOutStructure.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkBaseOutStructure.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBaseOutStructure.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkBaseOutStructure.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBaseOutStructure.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
@Nullable public static VkBaseOutStructure npNext(long struct)
Unsafe version ofpNext().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, @Nullable VkBaseOutStructure value)Unsafe version ofpNext.
-
-