public class VkDisplaySurfaceCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
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.
planeIndex must be less than the number of display planes supported by the device as determined by calling vkGetPhysicalDeviceDisplayPlanePropertiesKHRplaneReorderPossible 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 displayModealphaMode is DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR then globalAlpha must be between 0 and 1, inclusivealphaMode must be 0 or one of the bits present in the supportedAlpha member of VkDisplayPlaneCapabilitiesKHR returned by vkGetDisplayPlaneCapabilitiesKHR for the display plane corresponding to displayModewidth and height members of imageExtent must be less than the maxImageDimensions2D member of VkPhysicalDeviceLimitssType must be STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHRpNext must be NULLflags must be 0displayMode must be a valid VkDisplayModeKHR handletransform must be a valid VkSurfaceTransformFlagBitsKHR valuealphaMode must be a valid VkDisplayPlaneAlphaFlagBitsKHR valueVkExtent2D, CreateDisplayPlaneSurfaceKHR
sType – the type of this structure.pNext – NULL or a pointer to an extension-specific structure.flags – reserved for future use, and must be zero.displayMode – a VkDisplayModeKHR handle specifying the mode to use when displaying this surface.planeIndex – the plane on which this surface appears.planeStackIndex – the z-order of the plane.transform – a VkSurfaceTransformFlagBitsKHR value specifying the transformation to apply to images as part of the scanout operation.globalAlpha – the global alpha value. This value is ignored if alphaMode is not DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR.alphaMode – a VkDisplayPlaneAlphaFlagBitsKHR value specifying the type of alpha blending to use.imageExtent – The size of the presentable images to use with the surface.
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 |
|---|---|
static class |
VkDisplaySurfaceCreateInfoKHR.Buffer
An array of
VkDisplaySurfaceCreateInfoKHR structs. |
| Modifier and Type | Field and Description |
|---|---|
static int |
ALIGNOF
The struct alignment in bytes.
|
static int |
ALPHAMODE
The struct member offsets.
|
static int |
DISPLAYMODE
The struct member offsets.
|
static int |
FLAGS
The struct member offsets.
|
static int |
GLOBALALPHA
The struct member offsets.
|
static int |
IMAGEEXTENT
The struct member offsets.
|
static int |
PLANEINDEX
The struct member offsets.
|
static int |
PLANESTACKINDEX
The struct member offsets.
|
static int |
PNEXT
The struct member offsets.
|
static int |
SIZEOF
The struct size in bytes.
|
static int |
STYPE
The struct member offsets.
|
static int |
TRANSFORM
The struct member offsets.
|
| Constructor and Description |
|---|
VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)
Creates a
VkDisplaySurfaceCreateInfoKHR instance at the current position of the specified ByteBuffer container. |
| 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,
org.lwjgl.system.MemoryStack stack)
Returns a new
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero. |
static VkDisplaySurfaceCreateInfoKHR |
callocStack(org.lwjgl.system.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. |
static VkDisplaySurfaceCreateInfoKHR.Buffer |
create(long address,
int capacity)
Create a
VkDisplaySurfaceCreateInfoKHR.Buffer instance at the specified memory. |
static VkDisplaySurfaceCreateInfoKHR |
createSafe(long address)
|
static VkDisplaySurfaceCreateInfoKHR.Buffer |
createSafe(long address,
int capacity)
|
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(java.util.function.Consumer<VkExtent2D> consumer)
Passes the
imageExtent field to the specified Consumer. |
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,
org.lwjgl.system.MemoryStack stack)
Returns a new
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack. |
static VkDisplaySurfaceCreateInfoKHR |
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a new
VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack. |
static int |
nalphaMode(long struct)
Unsafe version of
alphaMode(). |
static void |
nalphaMode(long struct,
int value)
Unsafe version of
alphaMode. |
static long |
ndisplayMode(long struct)
Unsafe version of
displayMode(). |
static void |
ndisplayMode(long struct,
long value)
Unsafe version of
displayMode. |
static int |
nflags(long struct)
Unsafe version of
flags(). |
static void |
nflags(long struct,
int value)
Unsafe version of
flags. |
static float |
nglobalAlpha(long struct)
Unsafe version of
globalAlpha(). |
static void |
nglobalAlpha(long struct,
float value)
Unsafe version of
globalAlpha. |
static VkExtent2D |
nimageExtent(long struct)
Unsafe version of
imageExtent(). |
static void |
nimageExtent(long struct,
VkExtent2D value)
Unsafe version of
imageExtent. |
static int |
nplaneIndex(long struct)
Unsafe version of
planeIndex(). |
static void |
nplaneIndex(long struct,
int value)
Unsafe version of
planeIndex. |
static int |
nplaneStackIndex(long struct)
Unsafe version of
planeStackIndex(). |
static void |
nplaneStackIndex(long struct,
int value)
Unsafe version of
planeStackIndex. |
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 int |
ntransform(long struct)
Unsafe version of
transform(). |
static void |
ntransform(long struct,
int value)
Unsafe version of
transform. |
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() |
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. |
public static final int SIZEOF
public static final int ALIGNOF
public static final int STYPE
public static final int PNEXT
public static final int FLAGS
public static final int DISPLAYMODE
public static final int PLANEINDEX
public static final int PLANESTACKINDEX
public static final int TRANSFORM
public static final int GLOBALALPHA
public static final int ALPHAMODE
public static final int IMAGEEXTENT
public VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)
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.
public int sizeof()
sizeof in class org.lwjgl.system.Structpublic int sType()
sType field.public long pNext()
pNext field.public int flags()
flags field.public long displayMode()
displayMode field.public int planeIndex()
planeIndex field.public int planeStackIndex()
planeStackIndex field.public int transform()
transform field.public float globalAlpha()
globalAlpha field.public int alphaMode()
alphaMode field.public VkExtent2D imageExtent()
VkExtent2D view of the imageExtent field.public VkDisplaySurfaceCreateInfoKHR sType(int value)
sType field.public VkDisplaySurfaceCreateInfoKHR pNext(long value)
pNext field.public VkDisplaySurfaceCreateInfoKHR flags(int value)
flags field.public VkDisplaySurfaceCreateInfoKHR displayMode(long value)
displayMode field.public VkDisplaySurfaceCreateInfoKHR planeIndex(int value)
planeIndex field.public VkDisplaySurfaceCreateInfoKHR planeStackIndex(int value)
planeStackIndex field.public VkDisplaySurfaceCreateInfoKHR transform(int value)
transform field.public VkDisplaySurfaceCreateInfoKHR globalAlpha(float value)
globalAlpha field.public VkDisplaySurfaceCreateInfoKHR alphaMode(int value)
alphaMode field.public VkDisplaySurfaceCreateInfoKHR imageExtent(VkExtent2D value)
VkExtent2D to the imageExtent field.public VkDisplaySurfaceCreateInfoKHR imageExtent(java.util.function.Consumer<VkExtent2D> consumer)
imageExtent field to the specified Consumer.public VkDisplaySurfaceCreateInfoKHR set(int sType, long pNext, int flags, long displayMode, int planeIndex, int planeStackIndex, int transform, float globalAlpha, int alphaMode, VkExtent2D imageExtent)
public VkDisplaySurfaceCreateInfoKHR set(VkDisplaySurfaceCreateInfoKHR src)
src - the source structpublic static VkDisplaySurfaceCreateInfoKHR malloc()
VkDisplaySurfaceCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.public static VkDisplaySurfaceCreateInfoKHR calloc()
VkDisplaySurfaceCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.public static VkDisplaySurfaceCreateInfoKHR create()
VkDisplaySurfaceCreateInfoKHR instance allocated with BufferUtils.public static VkDisplaySurfaceCreateInfoKHR create(long address)
VkDisplaySurfaceCreateInfoKHR instance for the specified memory address.@Nullable public static VkDisplaySurfaceCreateInfoKHR createSafe(long address)
public static VkDisplaySurfaceCreateInfoKHR.Buffer malloc(int capacity)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.capacity - the buffer capacitypublic static VkDisplaySurfaceCreateInfoKHR.Buffer calloc(int capacity)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.capacity - the buffer capacitypublic static VkDisplaySurfaceCreateInfoKHR.Buffer create(int capacity)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.capacity - the buffer capacitypublic static VkDisplaySurfaceCreateInfoKHR.Buffer create(long address, int capacity)
VkDisplaySurfaceCreateInfoKHR.Buffer instance at the specified memory.address - the memory addresscapacity - the buffer capacity@Nullable public static VkDisplaySurfaceCreateInfoKHR.Buffer createSafe(long address, int capacity)
public static VkDisplaySurfaceCreateInfoKHR mallocStack()
VkDisplaySurfaceCreateInfoKHR instance allocated on the thread-local MemoryStack.public static VkDisplaySurfaceCreateInfoKHR callocStack()
VkDisplaySurfaceCreateInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.public static VkDisplaySurfaceCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack.stack - the stack from which to allocatepublic static VkDisplaySurfaceCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.stack - the stack from which to allocatepublic static VkDisplaySurfaceCreateInfoKHR.Buffer mallocStack(int capacity)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack.capacity - the buffer capacitypublic static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.capacity - the buffer capacitypublic static VkDisplaySurfaceCreateInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.stack - the stack from which to allocatecapacity - the buffer capacitypublic static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.stack - the stack from which to allocatecapacity - the buffer capacitypublic static int nsType(long struct)
sType().public static long npNext(long struct)
pNext().public static int nflags(long struct)
flags().public static long ndisplayMode(long struct)
displayMode().public static int nplaneIndex(long struct)
planeIndex().public static int nplaneStackIndex(long struct)
planeStackIndex().public static int ntransform(long struct)
transform().public static float nglobalAlpha(long struct)
globalAlpha().public static int nalphaMode(long struct)
alphaMode().public static VkExtent2D nimageExtent(long struct)
imageExtent().public static void nsType(long struct,
int value)
sType.public static void npNext(long struct,
long value)
pNext.public static void nflags(long struct,
int value)
flags.public static void ndisplayMode(long struct,
long value)
displayMode.public static void nplaneIndex(long struct,
int value)
planeIndex.public static void nplaneStackIndex(long struct,
int value)
planeStackIndex.public static void ntransform(long struct,
int value)
transform.public static void nglobalAlpha(long struct,
float value)
globalAlpha.public static void nalphaMode(long struct,
int value)
alphaMode.public static void nimageExtent(long struct,
VkExtent2D value)
imageExtent.Copyright LWJGL. All Rights Reserved. License terms.