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.NativeResourceStructure 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
planeIndexmust be less than the number of display planes supported by the device as determined by callingvkGetPhysicalDeviceDisplayPlanePropertiesKHR- If the
planeReorderPossiblemember of theVkDisplayPropertiesKHRstructure returned byvkGetPhysicalDeviceDisplayPropertiesKHRfor the display corresponding todisplayModeisTRUEthenplaneStackIndexmust be less than the number of display planes supported by the device as determined by callingvkGetPhysicalDeviceDisplayPlanePropertiesKHR; otherwiseplaneStackIndexmust equal thecurrentStackIndexmember ofVkDisplayPlanePropertiesKHRreturned byvkGetPhysicalDeviceDisplayPlanePropertiesKHRfor the display plane corresponding todisplayMode - If
alphaModeisDISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHRthenglobalAlphamust be between 0 and 1, inclusive alphaModemust be 0 or one of the bits present in thesupportedAlphamember ofVkDisplayPlaneCapabilitiesKHRreturned byvkGetDisplayPlaneCapabilitiesKHRfor the display plane corresponding todisplayMode- The
widthandheightmembers ofimageExtentmust be less than themaxImageDimensions2Dmember ofVkPhysicalDeviceLimits
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHRpNextmust beNULLflagsmust be 0displayModemust be a validVkDisplayModeKHRhandletransformmust be a validVkSurfaceTransformFlagBitsKHRvaluealphaModemust be a validVkDisplayPlaneAlphaFlagBitsKHRvalue
See Also
VkExtent2D,CreateDisplayPlaneSurfaceKHRMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– reserved for future use, and must be zero.displayMode– aVkDisplayModeKHRhandle 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– aVkSurfaceTransformFlagBitsKHRvalue specifying the transformation to apply to images as part of the scanout operation.globalAlpha– the global alpha value. This value is ignored ifalphaModeis notDISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR.alphaMode– aVkDisplayPlaneAlphaFlagBitsKHRvalue 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;VkExtent2DimageExtent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDisplaySurfaceCreateInfoKHR.BufferAn array ofVkDisplaySurfaceCreateInfoKHRstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intALPHAMODE
DISPLAYMODE
FLAGS
GLOBALALPHA
IMAGEEXTENT
PLANEINDEX
PLANESTACKINDEX
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
TRANSFORMThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)Creates aVkDisplaySurfaceCreateInfoKHRinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intalphaMode()Returns the value of thealphaModefield.VkDisplaySurfaceCreateInfoKHRalphaMode(int value)Sets the specified value to thealphaModefield.static VkDisplaySurfaceCreateInfoKHRcalloc()Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated withmemCalloc.static VkDisplaySurfaceCreateInfoKHR.Buffercalloc(int capacity)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated withmemCalloc.static VkDisplaySurfaceCreateInfoKHRcallocStack()Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHR.BuffercallocStack(int capacity)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHR.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHRcallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDisplaySurfaceCreateInfoKHRcreate()Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated withBufferUtils.static VkDisplaySurfaceCreateInfoKHR.Buffercreate(int capacity)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated withBufferUtils.static VkDisplaySurfaceCreateInfoKHRcreate(long address)Returns a newVkDisplaySurfaceCreateInfoKHRinstance for the specified memory address.static VkDisplaySurfaceCreateInfoKHR.Buffercreate(long address, int capacity)Create aVkDisplaySurfaceCreateInfoKHR.Bufferinstance at the specified memory.static VkDisplaySurfaceCreateInfoKHRcreateSafe(long address)static VkDisplaySurfaceCreateInfoKHR.BuffercreateSafe(long address, int capacity)longdisplayMode()Returns the value of thedisplayModefield.VkDisplaySurfaceCreateInfoKHRdisplayMode(long value)Sets the specified value to thedisplayModefield.intflags()Returns the value of theflagsfield.VkDisplaySurfaceCreateInfoKHRflags(int value)Sets the specified value to theflagsfield.floatglobalAlpha()Returns the value of theglobalAlphafield.VkDisplaySurfaceCreateInfoKHRglobalAlpha(float value)Sets the specified value to theglobalAlphafield.VkExtent2DimageExtent()Returns aVkExtent2Dview of theimageExtentfield.VkDisplaySurfaceCreateInfoKHRimageExtent(java.util.function.Consumer<VkExtent2D> consumer)Passes theimageExtentfield to the specifiedConsumer.VkDisplaySurfaceCreateInfoKHRimageExtent(VkExtent2D value)Copies the specifiedVkExtent2Dto theimageExtentfield.static VkDisplaySurfaceCreateInfoKHRmalloc()Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated withmemAlloc.static VkDisplaySurfaceCreateInfoKHR.Buffermalloc(int capacity)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated withmemAlloc.static VkDisplaySurfaceCreateInfoKHRmallocStack()Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the thread-localMemoryStack.static VkDisplaySurfaceCreateInfoKHR.BuffermallocStack(int capacity)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated on the thread-localMemoryStack.static VkDisplaySurfaceCreateInfoKHR.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkDisplaySurfaceCreateInfoKHRmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the specifiedMemoryStack.static intnalphaMode(long struct)Unsafe version ofalphaMode().static voidnalphaMode(long struct, int value)Unsafe version ofalphaMode.static longndisplayMode(long struct)Unsafe version ofdisplayMode().static voidndisplayMode(long struct, long value)Unsafe version ofdisplayMode.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static floatnglobalAlpha(long struct)Unsafe version ofglobalAlpha().static voidnglobalAlpha(long struct, float value)Unsafe version ofglobalAlpha.static VkExtent2DnimageExtent(long struct)Unsafe version ofimageExtent().static voidnimageExtent(long struct, VkExtent2D value)Unsafe version ofimageExtent.static intnplaneIndex(long struct)Unsafe version ofplaneIndex().static voidnplaneIndex(long struct, int value)Unsafe version ofplaneIndex.static intnplaneStackIndex(long struct)Unsafe version ofplaneStackIndex().static voidnplaneStackIndex(long struct, int value)Unsafe version ofplaneStackIndex.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intntransform(long struct)Unsafe version oftransform().static voidntransform(long struct, int value)Unsafe version oftransform.intplaneIndex()Returns the value of theplaneIndexfield.VkDisplaySurfaceCreateInfoKHRplaneIndex(int value)Sets the specified value to theplaneIndexfield.intplaneStackIndex()Returns the value of theplaneStackIndexfield.VkDisplaySurfaceCreateInfoKHRplaneStackIndex(int value)Sets the specified value to theplaneStackIndexfield.longpNext()Returns the value of thepNextfield.VkDisplaySurfaceCreateInfoKHRpNext(long value)Sets the specified value to thepNextfield.VkDisplaySurfaceCreateInfoKHRset(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.VkDisplaySurfaceCreateInfoKHRset(VkDisplaySurfaceCreateInfoKHR src)Copies the specified struct data to this struct.intsizeof()intsType()Returns the value of thesTypefield.VkDisplaySurfaceCreateInfoKHRsType(int value)Sets the specified value to thesTypefield.inttransform()Returns the value of thetransformfield.VkDisplaySurfaceCreateInfoKHRtransform(int value)Sets the specified value to thetransformfield.
-
-
-
Constructor Detail
-
VkDisplaySurfaceCreateInfoKHR
public VkDisplaySurfaceCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkDisplaySurfaceCreateInfoKHRinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
displayMode
public long displayMode()
Returns the value of thedisplayModefield.
-
planeIndex
public int planeIndex()
Returns the value of theplaneIndexfield.
-
planeStackIndex
public int planeStackIndex()
Returns the value of theplaneStackIndexfield.
-
transform
public int transform()
Returns the value of thetransformfield.
-
globalAlpha
public float globalAlpha()
Returns the value of theglobalAlphafield.
-
alphaMode
public int alphaMode()
Returns the value of thealphaModefield.
-
imageExtent
public VkExtent2D imageExtent()
Returns aVkExtent2Dview of theimageExtentfield.
-
sType
public VkDisplaySurfaceCreateInfoKHR sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkDisplaySurfaceCreateInfoKHR pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkDisplaySurfaceCreateInfoKHR flags(int value)
Sets the specified value to theflagsfield.
-
displayMode
public VkDisplaySurfaceCreateInfoKHR displayMode(long value)
Sets the specified value to thedisplayModefield.
-
planeIndex
public VkDisplaySurfaceCreateInfoKHR planeIndex(int value)
Sets the specified value to theplaneIndexfield.
-
planeStackIndex
public VkDisplaySurfaceCreateInfoKHR planeStackIndex(int value)
Sets the specified value to theplaneStackIndexfield.
-
transform
public VkDisplaySurfaceCreateInfoKHR transform(int value)
Sets the specified value to thetransformfield.
-
globalAlpha
public VkDisplaySurfaceCreateInfoKHR globalAlpha(float value)
Sets the specified value to theglobalAlphafield.
-
alphaMode
public VkDisplaySurfaceCreateInfoKHR alphaMode(int value)
Sets the specified value to thealphaModefield.
-
imageExtent
public VkDisplaySurfaceCreateInfoKHR imageExtent(VkExtent2D value)
Copies the specifiedVkExtent2Dto theimageExtentfield.
-
imageExtent
public VkDisplaySurfaceCreateInfoKHR imageExtent(java.util.function.Consumer<VkExtent2D> consumer)
Passes theimageExtentfield 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 newVkDisplaySurfaceCreateInfoKHRinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDisplaySurfaceCreateInfoKHR calloc()
Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDisplaySurfaceCreateInfoKHR create()
Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated withBufferUtils.
-
create
public static VkDisplaySurfaceCreateInfoKHR create(long address)
Returns a newVkDisplaySurfaceCreateInfoKHRinstance for the specified memory address.
-
createSafe
@Nullable public static VkDisplaySurfaceCreateInfoKHR createSafe(long address)
-
malloc
public static VkDisplaySurfaceCreateInfoKHR.Buffer malloc(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDisplaySurfaceCreateInfoKHR.Buffer calloc(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDisplaySurfaceCreateInfoKHR.Buffer create(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDisplaySurfaceCreateInfoKHR.Buffer create(long address, int capacity)
Create aVkDisplaySurfaceCreateInfoKHR.Bufferinstance 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 newVkDisplaySurfaceCreateInfoKHRinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR callocStack()
Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDisplaySurfaceCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplaySurfaceCreateInfoKHRinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDisplaySurfaceCreateInfoKHR.Buffer callocStack(int capacity)
Returns a newVkDisplaySurfaceCreateInfoKHR.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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.
-
-