Class VkDisplayPlaneCapabilitiesKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayPlaneCapabilitiesKHR
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDisplayPlaneCapabilitiesKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure describing capabilities of a mode and plane combination.Description
The minimum and maximum position and extent fields describe the implementation limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain's presentable images on the specified display plane. This is expressed by returning
minSrcPosition
,maxSrcPosition
,minSrcExtent
, andmaxSrcExtent
values that indicate a range of possible positions and sizes may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.Vendors may also support mapping the presentable images`' content to a subset or superset of the visible region in the specified display mode. This is expressed by returning
minDstPosition
,maxDstPosition
,minDstExtent
andmaxDstExtent
values that indicate a range of possible positions and sizes may be used to describe the region within the display mode that the source pixels will be mapped to.Other vendors may support only a 1-1 mapping between pixels in the presentable images and the display mode. This may be indicated by returning
(0,0)
forminSrcPosition
,maxSrcPosition
,minDstPosition
, andmaxDstPosition
, and (display mode width, display mode height) forminSrcExtent
,maxSrcExtent
,minDstExtent
, andmaxDstExtent
.These values indicate the limits of the implementation's individual fields. Not all combinations of values within the offset and extent ranges returned in
VkDisplayPlaneCapabilitiesKHR
are guaranteed to be supported. Vendors may still fail presentation requests that specify unsupported combinations.See Also
VkDisplayPlaneCapabilities2KHR
,VkExtent2D
,VkOffset2D
,GetDisplayPlaneCapabilitiesKHR
Member documentation
supportedAlpha
– a bitmask ofVkDisplayPlaneAlphaFlagBitsKHR
describing the supported alpha blending modes.minSrcPosition
– the minimum source rectangle offset supported by this plane using the specified mode.maxSrcPosition
– the maximum source rectangle offset supported by this plane using the specified mode. Thex
andy
components ofmaxSrcPosition
must each be greater than or equal to thex
andy
components ofminSrcPosition
, respectively.minSrcExtent
– the minimum source rectangle size supported by this plane using the specified mode.maxSrcExtent
– the maximum source rectangle size supported by this plane using the specified mode.minDstPosition
–minDstPosition
,maxDstPosition
,minDstExtent
,maxDstExtent
all have similar semantics to their corresponding ptext:Src equivalents, but apply to the output region within the mode rather than the input region within the source image. Unlike the ptext:Src offsets,minDstPosition
andmaxDstPosition
may contain negative values.maxDstPosition
– seeminDstPosition
minDstExtent
– seeminDstPosition
maxDstExtent
– seeminDstPosition
Layout
struct VkDisplayPlaneCapabilitiesKHR { VkDisplayPlaneAlphaFlagsKHR supportedAlpha;
VkOffset2D
minSrcPosition;VkOffset2D
maxSrcPosition;VkExtent2D
minSrcExtent;VkExtent2D
maxSrcExtent;VkOffset2D
minDstPosition;VkOffset2D
maxDstPosition;VkExtent2D
minDstExtent;VkExtent2D
maxDstExtent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDisplayPlaneCapabilitiesKHR.Buffer
An array ofVkDisplayPlaneCapabilitiesKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
MAXDSTEXTENT
MAXDSTPOSITION
MAXSRCEXTENT
MAXSRCPOSITION
MINDSTEXTENT
MINDSTPOSITION
MINSRCEXTENT
MINSRCPOSITIONThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
SUPPORTEDALPHA
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDisplayPlaneCapabilitiesKHR(java.nio.ByteBuffer container)
Creates aVkDisplayPlaneCapabilitiesKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDisplayPlaneCapabilitiesKHR
calloc()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated withmemCalloc
.static VkDisplayPlaneCapabilitiesKHR.Buffer
calloc(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated withmemCalloc
.static VkDisplayPlaneCapabilitiesKHR
callocStack()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneCapabilitiesKHR.Buffer
callocStack(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneCapabilitiesKHR.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneCapabilitiesKHR
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneCapabilitiesKHR
create()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated withBufferUtils
.static VkDisplayPlaneCapabilitiesKHR.Buffer
create(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayPlaneCapabilitiesKHR
create(long address)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance for the specified memory address.static VkDisplayPlaneCapabilitiesKHR.Buffer
create(long address, int capacity)
Create aVkDisplayPlaneCapabilitiesKHR.Buffer
instance at the specified memory.static VkDisplayPlaneCapabilitiesKHR
createSafe(long address)
static VkDisplayPlaneCapabilitiesKHR.Buffer
createSafe(long address, int capacity)
static VkDisplayPlaneCapabilitiesKHR
malloc()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated withmemAlloc
.static VkDisplayPlaneCapabilitiesKHR.Buffer
malloc(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated withmemAlloc
.static VkDisplayPlaneCapabilitiesKHR
mallocStack()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the thread-localMemoryStack
.static VkDisplayPlaneCapabilitiesKHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplayPlaneCapabilitiesKHR.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPlaneCapabilitiesKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the specifiedMemoryStack
.VkExtent2D
maxDstExtent()
Returns aVkExtent2D
view of themaxDstExtent
field.VkOffset2D
maxDstPosition()
Returns aVkOffset2D
view of themaxDstPosition
field.VkExtent2D
maxSrcExtent()
Returns aVkExtent2D
view of themaxSrcExtent
field.VkOffset2D
maxSrcPosition()
Returns aVkOffset2D
view of themaxSrcPosition
field.VkExtent2D
minDstExtent()
Returns aVkExtent2D
view of theminDstExtent
field.VkOffset2D
minDstPosition()
Returns aVkOffset2D
view of theminDstPosition
field.VkExtent2D
minSrcExtent()
Returns aVkExtent2D
view of theminSrcExtent
field.VkOffset2D
minSrcPosition()
Returns aVkOffset2D
view of theminSrcPosition
field.static VkExtent2D
nmaxDstExtent(long struct)
Unsafe version ofmaxDstExtent()
.static VkOffset2D
nmaxDstPosition(long struct)
Unsafe version ofmaxDstPosition()
.static VkExtent2D
nmaxSrcExtent(long struct)
Unsafe version ofmaxSrcExtent()
.static VkOffset2D
nmaxSrcPosition(long struct)
Unsafe version ofmaxSrcPosition()
.static VkExtent2D
nminDstExtent(long struct)
Unsafe version ofminDstExtent()
.static VkOffset2D
nminDstPosition(long struct)
Unsafe version ofminDstPosition()
.static VkExtent2D
nminSrcExtent(long struct)
Unsafe version ofminSrcExtent()
.static VkOffset2D
nminSrcPosition(long struct)
Unsafe version ofminSrcPosition()
.static int
nsupportedAlpha(long struct)
Unsafe version ofsupportedAlpha()
.int
sizeof()
int
supportedAlpha()
Returns the value of thesupportedAlpha
field.
-
-
-
Constructor Detail
-
VkDisplayPlaneCapabilitiesKHR
public VkDisplayPlaneCapabilitiesKHR(java.nio.ByteBuffer container)
Creates aVkDisplayPlaneCapabilitiesKHR
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
-
supportedAlpha
public int supportedAlpha()
Returns the value of thesupportedAlpha
field.
-
minSrcPosition
public VkOffset2D minSrcPosition()
Returns aVkOffset2D
view of theminSrcPosition
field.
-
maxSrcPosition
public VkOffset2D maxSrcPosition()
Returns aVkOffset2D
view of themaxSrcPosition
field.
-
minSrcExtent
public VkExtent2D minSrcExtent()
Returns aVkExtent2D
view of theminSrcExtent
field.
-
maxSrcExtent
public VkExtent2D maxSrcExtent()
Returns aVkExtent2D
view of themaxSrcExtent
field.
-
minDstPosition
public VkOffset2D minDstPosition()
Returns aVkOffset2D
view of theminDstPosition
field.
-
maxDstPosition
public VkOffset2D maxDstPosition()
Returns aVkOffset2D
view of themaxDstPosition
field.
-
minDstExtent
public VkExtent2D minDstExtent()
Returns aVkExtent2D
view of theminDstExtent
field.
-
maxDstExtent
public VkExtent2D maxDstExtent()
Returns aVkExtent2D
view of themaxDstExtent
field.
-
malloc
public static VkDisplayPlaneCapabilitiesKHR malloc()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplayPlaneCapabilitiesKHR calloc()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplayPlaneCapabilitiesKHR create()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated withBufferUtils
.
-
create
public static VkDisplayPlaneCapabilitiesKHR create(long address)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance for the specified memory address.
-
createSafe
@Nullable public static VkDisplayPlaneCapabilitiesKHR createSafe(long address)
-
malloc
public static VkDisplayPlaneCapabilitiesKHR.Buffer malloc(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplayPlaneCapabilitiesKHR.Buffer calloc(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPlaneCapabilitiesKHR.Buffer create(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPlaneCapabilitiesKHR.Buffer create(long address, int capacity)
Create aVkDisplayPlaneCapabilitiesKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDisplayPlaneCapabilitiesKHR.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDisplayPlaneCapabilitiesKHR mallocStack()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplayPlaneCapabilitiesKHR callocStack()
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplayPlaneCapabilitiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayPlaneCapabilitiesKHR callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDisplayPlaneCapabilitiesKHR.Buffer mallocStack(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplayPlaneCapabilitiesKHR.Buffer callocStack(int capacity)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplayPlaneCapabilitiesKHR.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplayPlaneCapabilitiesKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsupportedAlpha
public static int nsupportedAlpha(long struct)
Unsafe version ofsupportedAlpha()
.
-
nminSrcPosition
public static VkOffset2D nminSrcPosition(long struct)
Unsafe version ofminSrcPosition()
.
-
nmaxSrcPosition
public static VkOffset2D nmaxSrcPosition(long struct)
Unsafe version ofmaxSrcPosition()
.
-
nminSrcExtent
public static VkExtent2D nminSrcExtent(long struct)
Unsafe version ofminSrcExtent()
.
-
nmaxSrcExtent
public static VkExtent2D nmaxSrcExtent(long struct)
Unsafe version ofmaxSrcExtent()
.
-
nminDstPosition
public static VkOffset2D nminDstPosition(long struct)
Unsafe version ofminDstPosition()
.
-
nmaxDstPosition
public static VkOffset2D nmaxDstPosition(long struct)
Unsafe version ofmaxDstPosition()
.
-
nminDstExtent
public static VkExtent2D nminDstExtent(long struct)
Unsafe version ofminDstExtent()
.
-
nmaxDstExtent
public static VkExtent2D nmaxDstExtent(long struct)
Unsafe version ofmaxDstExtent()
.
-
-