Package org.lwjgl.vulkan
Class VkBaseOutStructure
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
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/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkBaseOutStructure
(ByteBuffer container) Creates aVkBaseOutStructure
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkBaseOutStructure
calloc()
Returns a newVkBaseOutStructure
instance allocated withmemCalloc
.static VkBaseOutStructure.Buffer
calloc
(int capacity) Returns a newVkBaseOutStructure.Buffer
instance allocated withmemCalloc
.static VkBaseOutStructure.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkBaseOutStructure.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBaseOutStructure
calloc
(MemoryStack stack) Returns a newVkBaseOutStructure
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBaseOutStructure
Deprecated.static VkBaseOutStructure.Buffer
callocStack
(int capacity) Deprecated.static VkBaseOutStructure.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkBaseOutStructure
callocStack
(MemoryStack stack) Deprecated.static VkBaseOutStructure
create()
Returns a newVkBaseOutStructure
instance allocated withBufferUtils
.static VkBaseOutStructure.Buffer
create
(int capacity) Returns a newVkBaseOutStructure.Buffer
instance allocated withBufferUtils
.static VkBaseOutStructure
create
(long address) Returns a newVkBaseOutStructure
instance for the specified memory address.static VkBaseOutStructure.Buffer
create
(long address, int capacity) Create aVkBaseOutStructure.Buffer
instance at the specified memory.static VkBaseOutStructure
createSafe
(long address) static VkBaseOutStructure.Buffer
createSafe
(long address, int capacity) static VkBaseOutStructure
malloc()
Returns a newVkBaseOutStructure
instance allocated withmemAlloc
.static VkBaseOutStructure.Buffer
malloc
(int capacity) Returns a newVkBaseOutStructure.Buffer
instance allocated withmemAlloc
.static VkBaseOutStructure.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkBaseOutStructure.Buffer
instance allocated on the specifiedMemoryStack
.static VkBaseOutStructure
malloc
(MemoryStack stack) Returns a newVkBaseOutStructure
instance allocated on the specifiedMemoryStack
.static VkBaseOutStructure
Deprecated.static VkBaseOutStructure.Buffer
mallocStack
(int capacity) Deprecated.static VkBaseOutStructure.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkBaseOutStructure
mallocStack
(MemoryStack stack) Deprecated.static VkBaseOutStructure
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, VkBaseOutStructure value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.pNext()
NULL
or a pointer to the next structure in a structure chain.pNext
(VkBaseOutStructure value) Sets the address of the specifiedVkBaseOutStructure
to thepNext()
field.set
(int sType, VkBaseOutStructure pNext) Initializes this struct with the specified values.set
(VkBaseOutStructure src) Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
sType()
the structure type of the structure being iterated through.sType
(int value) Sets the specified value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets.
-
-
Constructor Details
-
VkBaseOutStructure
Creates aVkBaseOutStructure
instance at the current position of the specifiedByteBuffer
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
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkBaseOutStructure>
-
sType
public int sType()the structure type of the structure being iterated through. -
pNext
NULL
or a pointer to the next structure in a structure chain. -
sType
Sets the specified value to thesType()
field. -
pNext
Sets the address of the specifiedVkBaseOutStructure
to thepNext()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkBaseOutStructure
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkBaseOutStructure
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkBaseOutStructure
instance allocated withBufferUtils
. -
create
Returns a newVkBaseOutStructure
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBaseOutStructure.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkBaseOutStructure.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkBaseOutStructure.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkBaseOutStructure.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkBaseOutStructure
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkBaseOutStructure
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkBaseOutStructure.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkBaseOutStructure.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType()
. -
npNext
Unsafe version ofpNext()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
Unsafe version ofpNext
.
-