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

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

public class VkDisplaySurfaceCreateInfoKHR
extends Struct

Khronos Reference Page
Vulkan Specification

Contains information about how a display surface should be created.

Valid Usage

sType must be STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR
pNext must be NULL
flags must be 0
displayMode must be a valid VkDisplayModeKHR handle
transform must be a valid VkSurfaceTransformFlagBitsKHR value
alphaMode must be a valid VkDisplayPlaneAlphaFlagBitsKHR value
planeIndex must be less than the number of display planes supported by the device as determined by calling GetPhysicalDeviceDisplayPlanePropertiesKHR
If the planeReorderPossible member of the VkDisplayPropertiesKHR structure returned by GetPhysicalDeviceDisplayPropertiesKHR for the display corresponding to displayMode is TRUE then planeStackIndex must be less than the number of display planes supported by the device as determined by calling GetPhysicalDeviceDisplayPlanePropertiesKHR; otherwise planeStackIndex must equal the currentStackIndex member of VkDisplayPlanePropertiesKHR returned by GetPhysicalDeviceDisplayPlanePropertiesKHR for the display plane corresponding to displayMode
If alphaMode is DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR then globalAlpha must be between 0 and 1, inclusive
alphaMode must be 0 or one of the bits present in the supportedAlpha member of VkDisplayPlaneCapabilitiesKHR returned by GetDisplayPlaneCapabilitiesKHR for the display plane corresponding to displayMode
The width and height members of imageExtent must be less than the maxImageDimensions2D member of VkPhysicalDeviceLimits

Member documentation

sType – the type of this structure. Must be: STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR
pNext – reserved for use by extensions
flags – reserved for future use, and must be zero
displayMode – the mode to use when displaying this surface
planeIndex – the plane on which this surface appears
planeStackIndex – the z-order of the plane

transform – the transform to apply to the images as part of the scannout operation. 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

globalAlpha – the global alpha value. This value is ignored if alphaMode is not DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR.
alphaMode – the type of alpha blending to use. One of:
DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR
DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR
imageExtent – the size of the presentable images to use with the surface

Layout

struct VkDisplaySurfaceCreateInfoKHR {
    VkStructureType sType;
    const void * pNext;
    VkDisplaySurfaceCreateFlagsKHR flags;
    VkDisplayModeKHR displayMode;
    uint32_t planeIndex;
    uint32_t planeStackIndex;
    VkSurfaceTransformFlagBitsKHR transform;
    float globalAlpha;
    VkDisplayPlaneAlphaFlagBitsKHR alphaMode;
    VkExtent2D imageExtent;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDisplaySurfaceCreateInfoKHR.Buffer
An array of VkDisplaySurfaceCreateInfoKHR 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
`VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)` Creates a `VkDisplaySurfaceCreateInfoKHR` 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
`int`	`alphaMode()` Returns the value of the `alphaMode` field.
`VkDisplaySurfaceCreateInfoKHR`	`alphaMode(int value)` Sets the specified value to the `alphaMode` field.
`static VkDisplaySurfaceCreateInfoKHR`	`calloc()` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated with `memCalloc`.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkDisplaySurfaceCreateInfoKHR`	`callocStack()` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplaySurfaceCreateInfoKHR`	`callocStack(MemoryStack stack)` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplaySurfaceCreateInfoKHR`	`create()` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated with `BufferUtils`.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkDisplaySurfaceCreateInfoKHR`	`create(long address)` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance for the specified memory address or `null` if the address is `NULL`.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplaySurfaceCreateInfoKHR.Buffer` instance at the specified memory.
`long`	`displayMode()` Returns the value of the `displayMode` field.
`VkDisplaySurfaceCreateInfoKHR`	`displayMode(long value)` Sets the specified value to the `displayMode` field.
`int`	`flags()` Returns the value of the `flags` field.
`VkDisplaySurfaceCreateInfoKHR`	`flags(int value)` Sets the specified value to the `flags` field.
`float`	`globalAlpha()` Returns the value of the `globalAlpha` field.
`VkDisplaySurfaceCreateInfoKHR`	`globalAlpha(float value)` Sets the specified value to the `globalAlpha` field.
`VkExtent2D`	`imageExtent()` Returns a `VkExtent2D` view of the `imageExtent` field.
`VkDisplaySurfaceCreateInfoKHR`	`imageExtent(VkExtent2D value)` Copies the specified `VkExtent2D` to the `imageExtent` field.
`static VkDisplaySurfaceCreateInfoKHR`	`malloc()` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated with `memAlloc`.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkDisplaySurfaceCreateInfoKHR`	`mallocStack()` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDisplaySurfaceCreateInfoKHR.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplaySurfaceCreateInfoKHR`	`mallocStack(MemoryStack stack)` Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated on the specified `MemoryStack`.
`VkDisplaySurfaceCreateInfoKHR`	`nset(long struct)` Unsafe version of `set`.
`int`	`planeIndex()` Returns the value of the `planeIndex` field.
`VkDisplaySurfaceCreateInfoKHR`	`planeIndex(int value)` Sets the specified value to the `planeIndex` field.
`int`	`planeStackIndex()` Returns the value of the `planeStackIndex` field.
`VkDisplaySurfaceCreateInfoKHR`	`planeStackIndex(int value)` Sets the specified value to the `planeStackIndex` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDisplaySurfaceCreateInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkDisplaySurfaceCreateInfoKHR`	`set(int sType, long pNext, int flags, long displayMode, int planeIndex, int planeStackIndex, int transform, float globalAlpha, int alphaMode, VkExtent2D imageExtent)` Initializes this struct with the specified values.
`VkDisplaySurfaceCreateInfoKHR`	`set(VkDisplaySurfaceCreateInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`sType()` Returns the value of the `sType` field.
`VkDisplaySurfaceCreateInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`transform()` Returns the value of the `transform` field.
`VkDisplaySurfaceCreateInfoKHR`	`transform(int value)` Sets the specified value to the `transform` 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
  - VkDisplaySurfaceCreateInfoKHR
```
public VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkDisplaySurfaceCreateInfoKHR 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - displayMode
```
public long displayMode()
```
    Returns the value of the displayMode field.
  - planeIndex
```
public int planeIndex()
```
    Returns the value of the planeIndex field.
  - planeStackIndex
```
public int planeStackIndex()
```
    Returns the value of the planeStackIndex field.
  - transform
```
public int transform()
```
    Returns the value of the transform field.
  - globalAlpha
```
public float globalAlpha()
```
    Returns the value of the globalAlpha field.
  - alphaMode
```
public int alphaMode()
```
    Returns the value of the alphaMode field.
  - imageExtent
```
public VkExtent2D imageExtent()
```
    Returns a VkExtent2D view of the imageExtent field.
  - sType
```
public VkDisplaySurfaceCreateInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDisplaySurfaceCreateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkDisplaySurfaceCreateInfoKHR flags(int value)
```
    Sets the specified value to the flags field.
  - displayMode
```
public VkDisplaySurfaceCreateInfoKHR displayMode(long value)
```
    Sets the specified value to the displayMode field.
  - planeIndex
```
public VkDisplaySurfaceCreateInfoKHR planeIndex(int value)
```
    Sets the specified value to the planeIndex field.
  - planeStackIndex
```
public VkDisplaySurfaceCreateInfoKHR planeStackIndex(int value)
```
    Sets the specified value to the planeStackIndex field.
  - transform
```
public VkDisplaySurfaceCreateInfoKHR transform(int value)
```
    Sets the specified value to the transform field.
  - globalAlpha
```
public VkDisplaySurfaceCreateInfoKHR globalAlpha(float value)
```
    Sets the specified value to the globalAlpha field.
  - alphaMode
```
public VkDisplaySurfaceCreateInfoKHR alphaMode(int value)
```
    Sets the specified value to the alphaMode field.
  - imageExtent
```
public VkDisplaySurfaceCreateInfoKHR imageExtent(VkExtent2D value)
```
    Copies the specified VkExtent2D to the imageExtent field.
  - set
```
public VkDisplaySurfaceCreateInfoKHR set(int sType,
                                         long pNext,
                                         int flags,
                                         long displayMode,
                                         int planeIndex,
                                         int planeStackIndex,
                                         int transform,
                                         float globalAlpha,
                                         int alphaMode,
                                         VkExtent2D imageExtent)
```
    Initializes this struct with the specified values.
  - nset
```
public VkDisplaySurfaceCreateInfoKHR nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkDisplaySurfaceCreateInfoKHR set(VkDisplaySurfaceCreateInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDisplaySurfaceCreateInfoKHR malloc()
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDisplaySurfaceCreateInfoKHR calloc()
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDisplaySurfaceCreateInfoKHR create()
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkDisplaySurfaceCreateInfoKHR create(long address)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer create(long address,
                                                          int capacity)
```
    Create a VkDisplaySurfaceCreateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplaySurfaceCreateInfoKHR mallocStack()
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDisplaySurfaceCreateInfoKHR callocStack()
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDisplaySurfaceCreateInfoKHR mallocStack(MemoryStack stack)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDisplaySurfaceCreateInfoKHR callocStack(MemoryStack stack)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer mallocStack(int capacity,
                                                               MemoryStack stack)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity,
                                                               MemoryStack stack)
```
    Returns a new VkDisplaySurfaceCreateInfoKHR.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

`DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR`	`DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR`
`DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR`	`DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR`

Class VkDisplaySurfaceCreateInfoKHR

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

VkDisplaySurfaceCreateInfoKHR

Method Detail

sizeof

sType

pNext

flags

displayMode

planeIndex

planeStackIndex

transform

globalAlpha

alphaMode

imageExtent

sType

pNext

flags

displayMode

planeIndex

planeStackIndex

transform

globalAlpha

alphaMode

imageExtent

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack