LWJGL 3.3.3 · org.lwjgl.vulkan.VkDisplaySurfaceCreateInfoKHR

Structure specifying parameters of a newly created display plane surface object.

Description

Note

Creating a display surface must not modify the state of the displays, planes, or other resources it names. For example, it must not apply the specified mode to be set on the associated display. Application of display configuration occurs as a side effect of presenting to a display surface.

Valid Usage

planeIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHR
If the planeReorderPossible member of the VkDisplayPropertiesKHR structure returned by vkGetPhysicalDeviceDisplayPropertiesKHR 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 vkGetPhysicalDeviceDisplayPlanePropertiesKHR; otherwise planeStackIndex must equal the currentStackIndex member of VkDisplayPlanePropertiesKHR returned by vkGetPhysicalDeviceDisplayPlanePropertiesKHR 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 one of the bits present in the supportedAlpha member of VkDisplayPlaneCapabilitiesKHR for the display plane corresponding to displayMode
transform must be one of the bits present in the supportedTransforms member of VkDisplayPropertiesKHR for the display corresponding to displayMode
The width and height members of imageExtent must be less than or equal to VkPhysicalDeviceLimits::maxImageDimension2D

Valid Usage (Implicit)

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

Layout


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

Modifier and Type	Class and Description
public static class	VkDisplaySurfaceCreateInfoKHR.Buffer An array of `VkDisplaySurfaceCreateInfoKHR` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ALPHAMODE The struct member offsets.
public static final int	DISPLAYMODE The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	GLOBALALPHA The struct member offsets.
public static final int	IMAGEEXTENT The struct member offsets.
public static final int	PLANEINDEX The struct member offsets.
public static final int	PLANESTACKINDEX The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	TRANSFORM The struct member offsets.

Access	Constructor and Description
protected	VkDisplaySurfaceCreateInfoKHR(long address, ByteBuffer container)
public	VkDisplaySurfaceCreateInfoKHR(ByteBuffer container) Creates a `VkDisplaySurfaceCreateInfoKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public int	alphaMode() a `VkDisplayPlaneAlphaFlagBitsKHR` value specifying the type of alpha blending to use.
public VkDisplaySurfaceCreateInfoKHR	alphaMode(int value) Sets the specified value to the `alphaMode` field.
public static VkDisplaySurfaceCreateInfoKHR	calloc() Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated with `memCalloc`.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
public static VkDisplaySurfaceCreateInfoKHR	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkDisplaySurfaceCreateInfoKHR	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDisplaySurfaceCreateInfoKHR	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkDisplaySurfaceCreateInfoKHR	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkDisplaySurfaceCreateInfoKHR	create() Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated with `BufferUtils`.
public static VkDisplaySurfaceCreateInfoKHR	create(long address) Returns a new `VkDisplaySurfaceCreateInfoKHR` instance for the specified memory address.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	create(int the buffer capacity capacity) Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkDisplaySurfaceCreateInfoKHR.Buffer` instance at the specified memory.
public static VkDisplaySurfaceCreateInfoKHR	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	displayMode() a `VkDisplayModeKHR` handle specifying the mode to use when displaying this surface.
public VkDisplaySurfaceCreateInfoKHR	displayMode(long value) Sets the specified value to the `displayMode` field.
public int	flags() reserved for future use, and must be zero.
public VkDisplaySurfaceCreateInfoKHR	flags(int value) Sets the specified value to the `flags` field.
public float	globalAlpha() the global alpha value.
public VkDisplaySurfaceCreateInfoKHR	globalAlpha(float value) Sets the specified value to the `globalAlpha` field.
public VkExtent2D	imageExtent() the size of the presentable images to use with the surface.
public VkDisplaySurfaceCreateInfoKHR	imageExtent(VkExtent2D value) Copies the specified `VkExtent2D` to the `imageExtent` field.
public VkDisplaySurfaceCreateInfoKHR	imageExtent(Consumer<VkExtent2D> consumer) Passes the `imageExtent` field to the specified `Consumer`.
public static VkDisplaySurfaceCreateInfoKHR	malloc() Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated with `memAlloc`.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
public static VkDisplaySurfaceCreateInfoKHR	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkDisplaySurfaceCreateInfoKHR` instance allocated on the specified `MemoryStack`.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkDisplaySurfaceCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
public static VkDisplaySurfaceCreateInfoKHR	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkDisplaySurfaceCreateInfoKHR	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkDisplaySurfaceCreateInfoKHR.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nalphaMode(long struct) Unsafe version of `alphaMode`.
public static void	nalphaMode(long struct, int value) Unsafe version of `alphaMode`.
public static long	ndisplayMode(long struct) Unsafe version of `displayMode`.
public static void	ndisplayMode(long struct, long value) Unsafe version of `displayMode`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static float	nglobalAlpha(long struct) Unsafe version of `globalAlpha`.
public static void	nglobalAlpha(long struct, float value) Unsafe version of `globalAlpha`.
public static VkExtent2D	nimageExtent(long struct) Unsafe version of `imageExtent`.
public static void	nimageExtent(long struct, VkExtent2D value) Unsafe version of `imageExtent`.
public static int	nplaneIndex(long struct) Unsafe version of `planeIndex`.
public static void	nplaneIndex(long struct, int value) Unsafe version of `planeIndex`.
public static int	nplaneStackIndex(long struct) Unsafe version of `planeStackIndex`.
public static void	nplaneStackIndex(long struct, int value) Unsafe version of `planeStackIndex`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	ntransform(long struct) Unsafe version of `transform`.
public static void	ntransform(long struct, int value) Unsafe version of `transform`.
public int	planeIndex() the plane on which this surface appears.
public VkDisplaySurfaceCreateInfoKHR	planeIndex(int value) Sets the specified value to the `planeIndex` field.
public int	planeStackIndex() the z-order of the plane.
public VkDisplaySurfaceCreateInfoKHR	planeStackIndex(int value) Sets the specified value to the `planeStackIndex` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkDisplaySurfaceCreateInfoKHR	pNext(long value) Sets the specified value to the `pNext` field.
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.
public VkDisplaySurfaceCreateInfoKHR	Returns: this struct set(VkDisplaySurfaceCreateInfoKHR the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkDisplaySurfaceCreateInfoKHR	sType(int value) Sets the specified value to the `sType` field.
public VkDisplaySurfaceCreateInfoKHR	sType$Default() Sets the `STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR` value to the `sType` field.
public int	transform() a `VkSurfaceTransformFlagBitsKHR` value specifying the transformation to apply to images as part of the scanout operation.
public VkDisplaySurfaceCreateInfoKHR	transform(int value) Sets the specified value to the `transform` field.

public Class VkDisplaySurfaceCreateInfoKHR

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary