Package org.lwjgl.vulkan
Class VkDisplayPlaneCapabilitiesKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayPlaneCapabilitiesKHR
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDisplayPlaneCapabilitiesKHR extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes capabilities of a mode and plane combination.
Valid Usage
supportedAlpha
must be a valid combination ofVkDisplayPlaneAlphaFlagBitsKHR
values
Member documentation
supportedAlpha
– a bitmask describing the supported alpha blending modes. One or more of:DISPLAY_PLANE_ALPHA_GLOBAL_BIT_KHR
DISPLAY_PLANE_ALPHA_OPAQUE_BIT_KHR
DISPLAY_PLANE_ALPHA_PER_PIXEL_BIT_KHR
DISPLAY_PLANE_ALPHA_PER_PIXEL_PREMULTIPLIED_BIT_KHR
minSrcPosition
– the minimum source rect offset supported by this plane using the specified modemaxSrcPosition
– the maximum source rect offset supported by this plane using the specified modeminSrcExtent
– the minimum source rect size supported by this plane using the specified modemaxSrcExtent
– the maximum source rect size supported by this plane using the specified modeminDstPosition
– the minimum output rect offset supported by this plane using the specified modemaxDstPosition
– the maximum output rect offset supported by this plane using the specified modeminDstExtent
– the minimum output rect size supported by this plane using the specified modemaxDstExtent
– the maximum output rect size supported by this plane using the specified mode
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 and Description static class
VkDisplayPlaneCapabilitiesKHR.Buffer
An array ofVkDisplayPlaneCapabilitiesKHR
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 and 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, MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlaneCapabilitiesKHR
callocStack(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 ornull
if the address isNULL
.static VkDisplayPlaneCapabilitiesKHR.Buffer
create(long address, int capacity)
Create aVkDisplayPlaneCapabilitiesKHR.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPlaneCapabilitiesKHR
mallocStack(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.int
sizeof()
Returns thesizeof(struct)
.int
supportedAlpha()
Returns the value of thesupportedAlpha
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:Struct
Returns thesizeof(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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkDisplayPlaneCapabilitiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayPlaneCapabilitiesKHR callocStack(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, 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, 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
-
-