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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkSurfaceCapabilitiesKHR
extends Struct

Khronos Reference Page
Vulkan Specification

Contains the basic capabilities of a surface.

Valid Usage

supportedTransforms must be a valid combination of VkSurfaceTransformFlagBitsKHR values
currentTransform must be a valid VkSurfaceTransformFlagBitsKHR value
supportedCompositeAlpha must be a valid combination of VkCompositeAlphaFlagBitsKHR values
supportedUsageFlags must be a valid combination of VkImageUsageFlagBits values

Member documentation

minImageCount – the minimum number of images the specified device supports for a swapchain created for the surface
maxImageCount – the maximum number of images the specified device supports for a swapchain created for the surface. A value of 0 means that there is no limit on the number of images, though there may be limits related to the total amount of memory used by swapchain images.
currentExtent – the current width and height of the surface, or the special value (0xFFFFFFFF,0xFFFFFFFF) indicating that the surface size will be determined by the extent of a swapchain targeting the surface
minImageExtent – the smallest valid swapchain extent for the surface on the specified device
maxImageExtent – the largest valid swapchain extent for the surface on the specified device
maxImageArrayLayers – the maximum number of layers swapchain images can have for a swapchain created for this device and surface

supportedTransforms – a bitfield of VkSurfaceTransformFlagBitsKHR, describing the presentation transforms supported for the surface on the specified device. One or more of:

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR

SURFACE_TRANSFORM_IDENTITY_BIT_KHR

SURFACE_TRANSFORM_INHERIT_BIT_KHR

SURFACE_TRANSFORM_ROTATE_180_BIT_KHR

SURFACE_TRANSFORM_ROTATE_270_BIT_KHR

SURFACE_TRANSFORM_ROTATE_90_BIT_KHR

currentTransform – a bitfield of VkSurfaceTransformFlagBitsKHR, describing the surface’s current transform relative to the presentation engine’s natural orientation. One of:

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR

SURFACE_TRANSFORM_IDENTITY_BIT_KHR

SURFACE_TRANSFORM_INHERIT_BIT_KHR

SURFACE_TRANSFORM_ROTATE_180_BIT_KHR

SURFACE_TRANSFORM_ROTATE_270_BIT_KHR

SURFACE_TRANSFORM_ROTATE_90_BIT_KHR

supportedCompositeAlpha – a bitfield of VkCompositeAlphaFlagBitsKHR, representing the alpha compositing modes supported by the presentation engine for the surface on the specified device. Opaque composition can be achieved in any alpha compositing mode by either using a swapchain image format that has no alpha component, or by ensuring that all pixels in the swapchain images have an alpha value of 1.0. One or more of:
COMPOSITE_ALPHA_INHERIT_BIT_KHR COMPOSITE_ALPHA_OPAQUE_BIT_KHR
COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR

supportedUsageFlags – a bitfield of VkImageUsageFlagBits representing the ways the application can use the presentable images of a swapchain created for the surface on the specified device. IMAGE_USAGE_COLOR_ATTACHMENT_BIT must be included in the set but implementations may support additional usages. One or more of:

`IMAGE_USAGE_COLOR_ATTACHMENT_BIT`	`IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT`
`IMAGE_USAGE_INPUT_ATTACHMENT_BIT`	`IMAGE_USAGE_SAMPLED_BIT`
`IMAGE_USAGE_STORAGE_BIT`	`IMAGE_USAGE_TRANSFER_DST_BIT`
`IMAGE_USAGE_TRANSFER_SRC_BIT`	`IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT`

Layout

struct VkSurfaceCapabilitiesKHR {
    uint32_t minImageCount;
    uint32_t maxImageCount;
    VkExtent2D currentExtent;
    VkExtent2D minImageExtent;
    VkExtent2D maxImageExtent;
    uint32_t maxImageArrayLayers;
    VkSurfaceTransformFlagsKHR supportedTransforms;
    VkSurfaceTransformFlagBitsKHR currentTransform;
    VkCompositeAlphaFlagsKHR supportedCompositeAlpha;
    VkImageUsageFlags supportedUsageFlags;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkSurfaceCapabilitiesKHR(java.nio.ByteBuffer container)` Creates a `VkSurfaceCapabilitiesKHR` 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 VkSurfaceCapabilitiesKHR`	`calloc()` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated with `memCalloc`.
`static VkSurfaceCapabilitiesKHR.Buffer`	`calloc(int capacity)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated with `memCalloc`.
`static VkSurfaceCapabilitiesKHR`	`callocStack()` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceCapabilitiesKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceCapabilitiesKHR.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceCapabilitiesKHR`	`callocStack(MemoryStack stack)` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkSurfaceCapabilitiesKHR`	`create()` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated with `BufferUtils`.
`static VkSurfaceCapabilitiesKHR.Buffer`	`create(int capacity)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated with `BufferUtils`.
`static VkSurfaceCapabilitiesKHR`	`create(long address)` Returns a new `VkSurfaceCapabilitiesKHR` instance for the specified memory address or `null` if the address is `NULL`.
`static VkSurfaceCapabilitiesKHR.Buffer`	`create(long address, int capacity)` Create a `VkSurfaceCapabilitiesKHR.Buffer` instance at the specified memory.
`VkExtent2D`	`currentExtent()` Returns a `VkExtent2D` view of the `currentExtent` field.
`int`	`currentTransform()` Returns the value of the `currentTransform` field.
`static VkSurfaceCapabilitiesKHR`	`malloc()` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated with `memAlloc`.
`static VkSurfaceCapabilitiesKHR.Buffer`	`malloc(int capacity)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated with `memAlloc`.
`static VkSurfaceCapabilitiesKHR`	`mallocStack()` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated on the thread-local `MemoryStack`.
`static VkSurfaceCapabilitiesKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkSurfaceCapabilitiesKHR.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkSurfaceCapabilitiesKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkSurfaceCapabilitiesKHR`	`mallocStack(MemoryStack stack)` Returns a new `VkSurfaceCapabilitiesKHR` instance allocated on the specified `MemoryStack`.
`int`	`maxImageArrayLayers()` Returns the value of the `maxImageArrayLayers` field.
`int`	`maxImageCount()` Returns the value of the `maxImageCount` field.
`VkExtent2D`	`maxImageExtent()` Returns a `VkExtent2D` view of the `maxImageExtent` field.
`int`	`minImageCount()` Returns the value of the `minImageCount` field.
`VkExtent2D`	`minImageExtent()` Returns a `VkExtent2D` view of the `minImageExtent` field.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`supportedCompositeAlpha()` Returns the value of the `supportedCompositeAlpha` field.
`int`	`supportedTransforms()` Returns the value of the `supportedTransforms` field.
`int`	`supportedUsageFlags()` Returns the value of the `supportedUsageFlags` field.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkSurfaceCapabilitiesKHR
```
public VkSurfaceCapabilitiesKHR(java.nio.ByteBuffer container)
```
    Creates a VkSurfaceCapabilitiesKHR 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - minImageCount
```
public int minImageCount()
```
    Returns the value of the minImageCount field.
  - maxImageCount
```
public int maxImageCount()
```
    Returns the value of the maxImageCount field.
  - currentExtent
```
public VkExtent2D currentExtent()
```
    Returns a VkExtent2D view of the currentExtent field.
  - minImageExtent
```
public VkExtent2D minImageExtent()
```
    Returns a VkExtent2D view of the minImageExtent field.
  - maxImageExtent
```
public VkExtent2D maxImageExtent()
```
    Returns a VkExtent2D view of the maxImageExtent field.
  - maxImageArrayLayers
```
public int maxImageArrayLayers()
```
    Returns the value of the maxImageArrayLayers field.
  - supportedTransforms
```
public int supportedTransforms()
```
    Returns the value of the supportedTransforms field.
  - currentTransform
```
public int currentTransform()
```
    Returns the value of the currentTransform field.
  - supportedCompositeAlpha
```
public int supportedCompositeAlpha()
```
    Returns the value of the supportedCompositeAlpha field.
  - supportedUsageFlags
```
public int supportedUsageFlags()
```
    Returns the value of the supportedUsageFlags field.
  - malloc
```
public static VkSurfaceCapabilitiesKHR malloc()
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkSurfaceCapabilitiesKHR calloc()
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkSurfaceCapabilitiesKHR create()
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated with BufferUtils.
  - create
```
public static VkSurfaceCapabilitiesKHR create(long address)
```
    Returns a new VkSurfaceCapabilitiesKHR instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkSurfaceCapabilitiesKHR.Buffer malloc(int capacity)
```
    Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkSurfaceCapabilitiesKHR.Buffer calloc(int capacity)
```
    Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSurfaceCapabilitiesKHR.Buffer create(int capacity)
```
    Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkSurfaceCapabilitiesKHR.Buffer create(long address,
                                                     int capacity)
```
    Create a VkSurfaceCapabilitiesKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSurfaceCapabilitiesKHR mallocStack()
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkSurfaceCapabilitiesKHR callocStack()
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkSurfaceCapabilitiesKHR mallocStack(MemoryStack stack)
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkSurfaceCapabilitiesKHR callocStack(MemoryStack stack)
```
    Returns a new VkSurfaceCapabilitiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSurfaceCapabilitiesKHR.Buffer callocStack(int capacity)
```
    Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkSurfaceCapabilitiesKHR.Buffer mallocStack(int capacity,
                                                          MemoryStack stack)
```
    Returns a new VkSurfaceCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkSurfaceCapabilitiesKHR.Buffer callocStack(int capacity,
                                                          MemoryStack stack)
```
    Returns a new VkSurfaceCapabilitiesKHR.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

`COMPOSITE_ALPHA_INHERIT_BIT_KHR`	`COMPOSITE_ALPHA_OPAQUE_BIT_KHR`
`COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR`	`COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR`

Class VkSurfaceCapabilitiesKHR

Valid Usage

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

Constructor Detail

VkSurfaceCapabilitiesKHR

Method Detail

sizeof

minImageCount

maxImageCount

currentExtent

minImageExtent

maxImageExtent

maxImageArrayLayers

supportedTransforms

currentTransform

supportedCompositeAlpha

supportedUsageFlags

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack