VkSurfaceFormatKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkSurfaceFormatKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing a supported swapchain format-color space pair.
Member documentation
- format – a VkFormat that is compatible with the specified surface.
- colorSpace – a presentation VkColorSpaceKHR that is compatible with the surface.
Layout
```
 struct VkSurfaceFormatKHR {
     VkFormat format;
     VkColorSpaceKHR colorSpace;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkSurfaceFormatKHR.Buffer
An array of VkSurfaceFormatKHR 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`	`VkSurfaceFormatKHR.Buffer` An array of `VkSurfaceFormatKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COLORSPACE` The struct member offsets.
`static int`	`FORMAT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkSurfaceFormatKHR(java.nio.ByteBuffer container)` Creates a `VkSurfaceFormatKHR` 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 VkSurfaceFormatKHR`	`calloc()` Returns a new `VkSurfaceFormatKHR` instance allocated with `memCalloc`.
`static VkSurfaceFormatKHR.Buffer`	`calloc(int capacity)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated with `memCalloc`.
`static VkSurfaceFormatKHR`	`callocStack()` Returns a new `VkSurfaceFormatKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormatKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormatKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceFormatKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormatKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`colorSpace()` Returns the value of the `colorSpace` field.
`static VkSurfaceFormatKHR`	`create()` Returns a new `VkSurfaceFormatKHR` instance allocated with `BufferUtils`.
`static VkSurfaceFormatKHR.Buffer`	`create(int capacity)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated with `BufferUtils`.
`static VkSurfaceFormatKHR`	`create(long address)` Returns a new `VkSurfaceFormatKHR` instance for the specified memory address.
`static VkSurfaceFormatKHR.Buffer`	`create(long address, int capacity)` Create a `VkSurfaceFormatKHR.Buffer` instance at the specified memory.
`static VkSurfaceFormatKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkSurfaceFormatKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`format()` Returns the value of the `format` field.
`static VkSurfaceFormatKHR`	`malloc()` Returns a new `VkSurfaceFormatKHR` instance allocated with `memAlloc`.
`static VkSurfaceFormatKHR.Buffer`	`malloc(int capacity)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated with `memAlloc`.
`static VkSurfaceFormatKHR`	`mallocStack()` Returns a new `VkSurfaceFormatKHR` instance allocated on the thread-local `MemoryStack`.
`static VkSurfaceFormatKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSurfaceFormatKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormatKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSurfaceFormatKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkSurfaceFormatKHR` instance allocated on the specified `MemoryStack`.
`static int`	`ncolorSpace(long struct)` Unsafe version of `colorSpace()`.
`static int`	`nformat(long struct)` Unsafe version of `format()`.
`int`	`sizeof()`

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.
  - FORMAT
```
public static final int FORMAT
```
    The struct member offsets.
  - COLORSPACE
```
public static final int COLORSPACE
```
    The struct member offsets.
- Constructor Detail
  - VkSurfaceFormatKHR
```
public VkSurfaceFormatKHR(java.nio.ByteBuffer container)
```
    Creates a VkSurfaceFormatKHR 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
  - format
```
public int format()
```
    Returns the value of the format field.
  - colorSpace
```
public int colorSpace()
```
    Returns the value of the colorSpace field.
  - malloc
```
public static VkSurfaceFormatKHR malloc()
```
    Returns a new VkSurfaceFormatKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSurfaceFormatKHR calloc()
```
    Returns a new VkSurfaceFormatKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSurfaceFormatKHR create()
```
    Returns a new VkSurfaceFormatKHR instance allocated with BufferUtils.
  - create
```
public static VkSurfaceFormatKHR create(long address)
```
    Returns a new VkSurfaceFormatKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkSurfaceFormatKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkSurfaceFormatKHR.Buffer malloc(int capacity)
```
    Returns a new VkSurfaceFormatKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSurfaceFormatKHR.Buffer calloc(int capacity)
```
    Returns a new VkSurfaceFormatKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSurfaceFormatKHR.Buffer create(int capacity)
```
    Returns a new VkSurfaceFormatKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSurfaceFormatKHR.Buffer create(long address,
                                               int capacity)
```
    Create a VkSurfaceFormatKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkSurfaceFormatKHR.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkSurfaceFormatKHR mallocStack()
```
    Returns a new VkSurfaceFormatKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSurfaceFormatKHR callocStack()
```
    Returns a new VkSurfaceFormatKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSurfaceFormatKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormatKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSurfaceFormatKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormatKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSurfaceFormatKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkSurfaceFormatKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSurfaceFormatKHR.Buffer callocStack(int capacity)
```
    Returns a new VkSurfaceFormatKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSurfaceFormatKHR.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormatKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSurfaceFormatKHR.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkSurfaceFormatKHR.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
  - nformat
```
public static int nformat(long struct)
```
    Unsafe version of format().
  - ncolorSpace
```
public static int ncolorSpace(long struct)
```
    Unsafe version of colorSpace().

Class VkSurfaceFormatKHR

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

FORMAT

COLORSPACE

Constructor Detail

VkSurfaceFormatKHR

Method Detail

sizeof

format

colorSpace

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nformat

ncolorSpace