VkBaseOutStructure (LWJGL 3.2.4 SNAPSHOT

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.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

Member documentation
- sType – the structure type of the structure being iterated through.
- pNext – NULL or 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 and Description

static class VkBaseOutStructure.Buffer
An array of VkBaseOutStructure structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkBaseOutStructure.Buffer` An array of `VkBaseOutStructure` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static 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 and Description
`VkBaseOutStructure(java.nio.ByteBuffer container)` Creates a `VkBaseOutStructure` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkBaseOutStructure` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBaseOutStructure.Buffer`	`callocStack(int capacity)` Returns a new `VkBaseOutStructure.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBaseOutStructure.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBaseOutStructure` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 VkBaseOutStructure`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static 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`	`mallocStack()` Returns a new `VkBaseOutStructure` instance allocated on the thread-local `MemoryStack`.
`static VkBaseOutStructure.Buffer`	`mallocStack(int capacity)` Returns a new `VkBaseOutStructure.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBaseOutStructure.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBaseOutStructure.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBaseOutStructure`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBaseOutStructure` instance allocated on the specified `MemoryStack`.
`static VkBaseOutStructure`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, 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`.
`VkBaseOutStructure`	`pNext()` Returns a `VkBaseOutStructure` view of the struct pointed to by the `pNext` field.
`VkBaseOutStructure`	`pNext(VkBaseOutStructure value)` Sets the address of the specified `VkBaseOutStructure` to the `pNext` field.
`VkBaseOutStructure`	`set(int sType, 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()` Returns the value of the `sType` field.
`VkBaseOutStructure`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - VkBaseOutStructure
```
public VkBaseOutStructure(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
@Nullable
public VkBaseOutStructure pNext()
```
    Returns a VkBaseOutStructure view of the struct pointed to by the pNext field.
  - 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
```
@Nullable
public static 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
```
@Nullable
public static VkBaseOutStructure.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBaseOutStructure mallocStack()
```
    Returns a new VkBaseOutStructure instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBaseOutStructure callocStack()
```
    Returns a new VkBaseOutStructure instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBaseOutStructure mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBaseOutStructure instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBaseOutStructure callocStack(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
  - mallocStack
```
public static VkBaseOutStructure.Buffer mallocStack(int capacity)
```
    Returns a new VkBaseOutStructure.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBaseOutStructure.Buffer callocStack(int capacity)
```
    Returns a new VkBaseOutStructure.Buffer instance allocated on the thread-local MemoryStack and 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 new VkBaseOutStructure.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBaseOutStructure.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
@Nullable
public static 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.

Class VkBaseOutStructure

Description

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

Constructor Detail

VkBaseOutStructure

Method Detail

sizeof

sType

pNext

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nsType

npNext