VkSurfaceFormat2KHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkSurfaceFormat2KHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSurfaceFormat2KHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing a supported swapchain format tuple.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR
- pNext must be NULL
See Also

VkSurfaceFormatKHR, GetPhysicalDeviceSurfaceFormats2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- surfaceFormat – a VkSurfaceFormatKHR structure describing a format-color space pair that is compatible with the specified surface.
Layout
```
 struct VkSurfaceFormat2KHR {
     VkStructureType sType;
     void * pNext;
     VkSurfaceFormatKHR surfaceFormat;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkSurfaceFormat2KHR.Buffer
An array of VkSurfaceFormat2KHR 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`	`VkSurfaceFormat2KHR.Buffer` An array of `VkSurfaceFormat2KHR` 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.
`static int`	`SURFACEFORMAT` 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
`VkSurfaceFormat2KHR(java.nio.ByteBuffer container)` Creates a `VkSurfaceFormat2KHR` 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 VkSurfaceFormat2KHR`	`calloc()` Returns a new `VkSurfaceFormat2KHR` instance allocated with `memCalloc`.
`static VkSurfaceFormat2KHR.Buffer`	`calloc(int capacity)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated with `memCalloc`.
`static VkSurfaceFormat2KHR`	`callocStack()` Returns a new `VkSurfaceFormat2KHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormat2KHR.Buffer`	`callocStack(int capacity)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormat2KHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormat2KHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormat2KHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormat2KHR`	`create()` Returns a new `VkSurfaceFormat2KHR` instance allocated with `BufferUtils`.
`static VkSurfaceFormat2KHR.Buffer`	`create(int capacity)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated with `BufferUtils`.
`static VkSurfaceFormat2KHR`	`create(long address)` Returns a new `VkSurfaceFormat2KHR` instance for the specified memory address.
`static VkSurfaceFormat2KHR.Buffer`	`create(long address, int capacity)` Create a `VkSurfaceFormat2KHR.Buffer` instance at the specified memory.
`static VkSurfaceFormat2KHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSurfaceFormat2KHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSurfaceFormat2KHR`	`malloc()` Returns a new `VkSurfaceFormat2KHR` instance allocated with `memAlloc`.
`static VkSurfaceFormat2KHR.Buffer`	`malloc(int capacity)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated with `memAlloc`.
`static VkSurfaceFormat2KHR`	`mallocStack()` Returns a new `VkSurfaceFormat2KHR` instance allocated on the thread-local `MemoryStack`.
`static VkSurfaceFormat2KHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSurfaceFormat2KHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormat2KHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSurfaceFormat2KHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormat2KHR` instance allocated on the specified `MemoryStack`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long 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`.
`static VkSurfaceFormatKHR`	`nsurfaceFormat(long struct)` Unsafe version of `surfaceFormat()`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkSurfaceFormat2KHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkSurfaceFormat2KHR`	`set(int sType, long pNext)` Initializes this struct with the specified values.
`VkSurfaceFormat2KHR`	`set(VkSurfaceFormat2KHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkSurfaceFormat2KHR`	`sType(int value)` Sets the specified value to the `sType` field.
`VkSurfaceFormatKHR`	`surfaceFormat()` Returns a `VkSurfaceFormatKHR` view of the `surfaceFormat` 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.
  - SURFACEFORMAT
```
public static final int SURFACEFORMAT
```
    The struct member offsets.
- Constructor Detail
  - VkSurfaceFormat2KHR
```
public VkSurfaceFormat2KHR(java.nio.ByteBuffer container)
```
    Creates a VkSurfaceFormat2KHR 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
```
public long pNext()
```
    Returns the value of the pNext field.
  - surfaceFormat
```
public VkSurfaceFormatKHR surfaceFormat()
```
    Returns a VkSurfaceFormatKHR view of the surfaceFormat field.
  - sType
```
public VkSurfaceFormat2KHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkSurfaceFormat2KHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - set
```
public VkSurfaceFormat2KHR set(int sType,
                               long pNext)
```
    Initializes this struct with the specified values.
  - set
```
public VkSurfaceFormat2KHR set(VkSurfaceFormat2KHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkSurfaceFormat2KHR malloc()
```
    Returns a new VkSurfaceFormat2KHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSurfaceFormat2KHR calloc()
```
    Returns a new VkSurfaceFormat2KHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSurfaceFormat2KHR create()
```
    Returns a new VkSurfaceFormat2KHR instance allocated with BufferUtils.
  - create
```
public static VkSurfaceFormat2KHR create(long address)
```
    Returns a new VkSurfaceFormat2KHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSurfaceFormat2KHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSurfaceFormat2KHR.Buffer malloc(int capacity)
```
    Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSurfaceFormat2KHR.Buffer calloc(int capacity)
```
    Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSurfaceFormat2KHR.Buffer create(int capacity)
```
    Returns a new VkSurfaceFormat2KHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSurfaceFormat2KHR.Buffer create(long address,
                                                int capacity)
```
    Create a VkSurfaceFormat2KHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSurfaceFormat2KHR.Buffer createSafe(long address,
                                                              int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSurfaceFormat2KHR mallocStack()
```
    Returns a new VkSurfaceFormat2KHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSurfaceFormat2KHR callocStack()
```
    Returns a new VkSurfaceFormat2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSurfaceFormat2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormat2KHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSurfaceFormat2KHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormat2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSurfaceFormat2KHR.Buffer mallocStack(int capacity)
```
    Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSurfaceFormat2KHR.Buffer callocStack(int capacity)
```
    Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSurfaceFormat2KHR.Buffer mallocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormat2KHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSurfaceFormat2KHR.Buffer callocStack(int capacity,
                                                     org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormat2KHR.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
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nsurfaceFormat
```
public static VkSurfaceFormatKHR nsurfaceFormat(long struct)
```
    Unsafe version of surfaceFormat().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.

Class VkSurfaceFormat2KHR

Valid Usage (Implicit)

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

SURFACEFORMAT

Constructor Detail

VkSurfaceFormat2KHR

Method Detail

sizeof

sType

pNext

surfaceFormat

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nsurfaceFormat

nsType

npNext