Package org.lwjgl.vulkan
Class VkDisplaySurfaceCreateInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplaySurfaceCreateInfoKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDisplaySurfaceCreateInfoKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
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 callingvkGetPhysicalDeviceDisplayPlanePropertiesKHR
- If the
planeReorderPossible
member of theVkDisplayPropertiesKHR
structure returned byvkGetPhysicalDeviceDisplayPropertiesKHR
for the display corresponding todisplayMode
isTRUE
thenplaneStackIndex
must be less than the number of display planes supported by the device as determined by callingvkGetPhysicalDeviceDisplayPlanePropertiesKHR
; otherwiseplaneStackIndex
must equal thecurrentStackIndex
member ofVkDisplayPlanePropertiesKHR
returned byvkGetPhysicalDeviceDisplayPlanePropertiesKHR
for the display plane corresponding todisplayMode
- If
alphaMode
isDISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
thenglobalAlpha
must be between 0 and 1, inclusive alphaMode
must be 0 or one of the bits present in thesupportedAlpha
member ofVkDisplayPlaneCapabilitiesKHR
returned byvkGetDisplayPlaneCapabilitiesKHR
for the display plane corresponding todisplayMode
- The
width
andheight
members ofimageExtent
must be less than themaxImageDimensions2D
member ofVkPhysicalDeviceLimits
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR
pNext
must beNULL
flags
must be 0displayMode
must be a validVkDisplayModeKHR
handletransform
must be a validVkSurfaceTransformFlagBitsKHR
valuealphaMode
must be a validVkDisplayPlaneAlphaFlagBitsKHR
value
See Also
VkExtent2D
,CreateDisplayPlaneSurfaceKHR
Member documentation
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
– aVkDisplayModeKHR
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
– aVkSurfaceTransformFlagBitsKHR
value specifying the transformation to apply to images as part of the scanout operation.globalAlpha
– the global alpha value. This value is ignored ifalphaMode
is notDISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
.alphaMode
– aVkDisplayPlaneAlphaFlagBitsKHR
value specifying the type of alpha blending to use.imageExtent
– The size of the presentable images to use with the surface.
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; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDisplaySurfaceCreateInfoKHR.Buffer
An array ofVkDisplaySurfaceCreateInfoKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
ALPHAMODE
DISPLAYMODE
FLAGS
GLOBALALPHA
IMAGEEXTENT
PLANEINDEX
PLANESTACKINDEX
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
TRANSFORMThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkDisplaySurfaceCreateInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
alphaMode()
Returns the value of thealphaMode
field.VkDisplaySurfaceCreateInfoKHR
alphaMode(int value)
Sets the specified value to thealphaMode
field.static VkDisplaySurfaceCreateInfoKHR
calloc()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated withmemCalloc
.static VkDisplaySurfaceCreateInfoKHR.Buffer
calloc(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated withmemCalloc
.static VkDisplaySurfaceCreateInfoKHR
callocStack()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHR
create()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated withBufferUtils
.static VkDisplaySurfaceCreateInfoKHR.Buffer
create(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated withBufferUtils
.static VkDisplaySurfaceCreateInfoKHR
create(long address)
Returns a newVkDisplaySurfaceCreateInfoKHR
instance for the specified memory address.static VkDisplaySurfaceCreateInfoKHR.Buffer
create(long address, int capacity)
Create aVkDisplaySurfaceCreateInfoKHR.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 thedisplayMode
field.VkDisplaySurfaceCreateInfoKHR
displayMode(long value)
Sets the specified value to thedisplayMode
field.int
flags()
Returns the value of theflags
field.VkDisplaySurfaceCreateInfoKHR
flags(int value)
Sets the specified value to theflags
field.float
globalAlpha()
Returns the value of theglobalAlpha
field.VkDisplaySurfaceCreateInfoKHR
globalAlpha(float value)
Sets the specified value to theglobalAlpha
field.VkExtent2D
imageExtent()
Returns aVkExtent2D
view of theimageExtent
field.VkDisplaySurfaceCreateInfoKHR
imageExtent(java.util.function.Consumer<VkExtent2D> consumer)
Passes theimageExtent
field to the specifiedConsumer
.VkDisplaySurfaceCreateInfoKHR
imageExtent(VkExtent2D value)
Copies the specifiedVkExtent2D
to theimageExtent
field.static VkDisplaySurfaceCreateInfoKHR
malloc()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated withmemAlloc
.static VkDisplaySurfaceCreateInfoKHR.Buffer
malloc(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated withmemAlloc
.static VkDisplaySurfaceCreateInfoKHR
mallocStack()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the thread-localMemoryStack
.static VkDisplaySurfaceCreateInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplaySurfaceCreateInfoKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplaySurfaceCreateInfoKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the specifiedMemoryStack
.static int
nalphaMode(long struct)
Unsafe version ofalphaMode()
.static void
nalphaMode(long struct, int value)
Unsafe version ofalphaMode
.static long
ndisplayMode(long struct)
Unsafe version ofdisplayMode()
.static void
ndisplayMode(long struct, long value)
Unsafe version ofdisplayMode
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static float
nglobalAlpha(long struct)
Unsafe version ofglobalAlpha()
.static void
nglobalAlpha(long struct, float value)
Unsafe version ofglobalAlpha
.static VkExtent2D
nimageExtent(long struct)
Unsafe version ofimageExtent()
.static void
nimageExtent(long struct, VkExtent2D value)
Unsafe version ofimageExtent
.static int
nplaneIndex(long struct)
Unsafe version ofplaneIndex()
.static void
nplaneIndex(long struct, int value)
Unsafe version ofplaneIndex
.static int
nplaneStackIndex(long struct)
Unsafe version ofplaneStackIndex()
.static void
nplaneStackIndex(long struct, int value)
Unsafe version ofplaneStackIndex
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
ntransform(long struct)
Unsafe version oftransform()
.static void
ntransform(long struct, int value)
Unsafe version oftransform
.int
planeIndex()
Returns the value of theplaneIndex
field.VkDisplaySurfaceCreateInfoKHR
planeIndex(int value)
Sets the specified value to theplaneIndex
field.int
planeStackIndex()
Returns the value of theplaneStackIndex
field.VkDisplaySurfaceCreateInfoKHR
planeStackIndex(int value)
Sets the specified value to theplaneStackIndex
field.long
pNext()
Returns the value of thepNext
field.VkDisplaySurfaceCreateInfoKHR
pNext(long value)
Sets the specified value to thepNext
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 thesType
field.VkDisplaySurfaceCreateInfoKHR
sType(int value)
Sets the specified value to thesType
field.int
transform()
Returns the value of thetransform
field.VkDisplaySurfaceCreateInfoKHR
transform(int value)
Sets the specified value to thetransform
field.
-
-
-
Constructor Detail
-
VkDisplaySurfaceCreateInfoKHR
public VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkDisplaySurfaceCreateInfoKHR
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
displayMode
public long displayMode()
Returns the value of thedisplayMode
field.
-
planeIndex
public int planeIndex()
Returns the value of theplaneIndex
field.
-
planeStackIndex
public int planeStackIndex()
Returns the value of theplaneStackIndex
field.
-
transform
public int transform()
Returns the value of thetransform
field.
-
globalAlpha
public float globalAlpha()
Returns the value of theglobalAlpha
field.
-
alphaMode
public int alphaMode()
Returns the value of thealphaMode
field.
-
imageExtent
public VkExtent2D imageExtent()
Returns aVkExtent2D
view of theimageExtent
field.
-
sType
public VkDisplaySurfaceCreateInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDisplaySurfaceCreateInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkDisplaySurfaceCreateInfoKHR flags(int value)
Sets the specified value to theflags
field.
-
displayMode
public VkDisplaySurfaceCreateInfoKHR displayMode(long value)
Sets the specified value to thedisplayMode
field.
-
planeIndex
public VkDisplaySurfaceCreateInfoKHR planeIndex(int value)
Sets the specified value to theplaneIndex
field.
-
planeStackIndex
public VkDisplaySurfaceCreateInfoKHR planeStackIndex(int value)
Sets the specified value to theplaneStackIndex
field.
-
transform
public VkDisplaySurfaceCreateInfoKHR transform(int value)
Sets the specified value to thetransform
field.
-
globalAlpha
public VkDisplaySurfaceCreateInfoKHR globalAlpha(float value)
Sets the specified value to theglobalAlpha
field.
-
alphaMode
public VkDisplaySurfaceCreateInfoKHR alphaMode(int value)
Sets the specified value to thealphaMode
field.
-
imageExtent
public VkDisplaySurfaceCreateInfoKHR imageExtent(VkExtent2D value)
Copies the specifiedVkExtent2D
to theimageExtent
field.
-
imageExtent
public VkDisplaySurfaceCreateInfoKHR imageExtent(java.util.function.Consumer<VkExtent2D> consumer)
Passes theimageExtent
field to the specifiedConsumer
.
-
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.
-
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 newVkDisplaySurfaceCreateInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplaySurfaceCreateInfoKHR calloc()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplaySurfaceCreateInfoKHR create()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkDisplaySurfaceCreateInfoKHR create(long address)
Returns a newVkDisplaySurfaceCreateInfoKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkDisplaySurfaceCreateInfoKHR createSafe(long address)
-
malloc
public static VkDisplaySurfaceCreateInfoKHR.Buffer malloc(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplaySurfaceCreateInfoKHR.Buffer calloc(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplaySurfaceCreateInfoKHR.Buffer create(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplaySurfaceCreateInfoKHR.Buffer create(long address, int capacity)
Create aVkDisplaySurfaceCreateInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDisplaySurfaceCreateInfoKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDisplaySurfaceCreateInfoKHR mallocStack()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR callocStack()
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplaySurfaceCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR
instance allocated on the specifiedMemoryStack
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 newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplaySurfaceCreateInfoKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nflags
public static int nflags(long struct)
Unsafe version offlags()
.
-
ndisplayMode
public static long ndisplayMode(long struct)
Unsafe version ofdisplayMode()
.
-
nplaneIndex
public static int nplaneIndex(long struct)
Unsafe version ofplaneIndex()
.
-
nplaneStackIndex
public static int nplaneStackIndex(long struct)
Unsafe version ofplaneStackIndex()
.
-
ntransform
public static int ntransform(long struct)
Unsafe version oftransform()
.
-
nglobalAlpha
public static float nglobalAlpha(long struct)
Unsafe version ofglobalAlpha()
.
-
nalphaMode
public static int nalphaMode(long struct)
Unsafe version ofalphaMode()
.
-
nimageExtent
public static VkExtent2D nimageExtent(long struct)
Unsafe version ofimageExtent()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nflags
public static void nflags(long struct, int value)
Unsafe version offlags
.
-
ndisplayMode
public static void ndisplayMode(long struct, long value)
Unsafe version ofdisplayMode
.
-
nplaneIndex
public static void nplaneIndex(long struct, int value)
Unsafe version ofplaneIndex
.
-
nplaneStackIndex
public static void nplaneStackIndex(long struct, int value)
Unsafe version ofplaneStackIndex
.
-
ntransform
public static void ntransform(long struct, int value)
Unsafe version oftransform
.
-
nglobalAlpha
public static void nglobalAlpha(long struct, float value)
Unsafe version ofglobalAlpha
.
-
nalphaMode
public static void nalphaMode(long struct, int value)
Unsafe version ofalphaMode
.
-
nimageExtent
public static void nimageExtent(long struct, VkExtent2D value)
Unsafe version ofimageExtent
.
-
-