Package org.lwjgl.vulkan
Class VkDisplayPlanePropertiesKHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkDisplayPlanePropertiesKHR
extends Struct<VkDisplayPlanePropertiesKHR>
implements NativeResource
Structure describing display plane properties.
See Also
VkDisplayPlaneProperties2KHR
, GetPhysicalDeviceDisplayPlanePropertiesKHR
Layout
struct VkDisplayPlanePropertiesKHR {
VkDisplayKHR currentDisplay()
;
uint32_t currentStackIndex()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkDisplayPlanePropertiesKHR
(ByteBuffer container) Creates aVkDisplayPlanePropertiesKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkDisplayPlanePropertiesKHR
calloc()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR
calloc
(MemoryStack stack) Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkDisplayPlanePropertiesKHR
callocStack
(MemoryStack stack) Deprecated.static VkDisplayPlanePropertiesKHR
create()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayPlanePropertiesKHR
create
(long address) Returns a newVkDisplayPlanePropertiesKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkDisplayPlanePropertiesKHR.Buffer
instance at the specified memory.static VkDisplayPlanePropertiesKHR
createSafe
(long address) createSafe
(long address, int capacity) long
the handle of the display the plane is currently associated with.int
the current z-order of the plane.static VkDisplayPlanePropertiesKHR
malloc()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPlanePropertiesKHR
malloc
(MemoryStack stack) Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
.static VkDisplayPlanePropertiesKHR
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkDisplayPlanePropertiesKHR
mallocStack
(MemoryStack stack) Deprecated.static long
ncurrentDisplay
(long struct) Unsafe version ofcurrentDisplay()
.static int
ncurrentStackIndex
(long struct) Unsafe version ofcurrentStackIndex()
.int
sizeof()
Returnssizeof(struct)
.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
CURRENTDISPLAY
public static final int CURRENTDISPLAYThe struct member offsets. -
CURRENTSTACKINDEX
public static final int CURRENTSTACKINDEXThe struct member offsets.
-
-
Constructor Details
-
VkDisplayPlanePropertiesKHR
Creates aVkDisplayPlanePropertiesKHR
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkDisplayPlanePropertiesKHR>
-
currentDisplay
public long currentDisplay()the handle of the display the plane is currently associated with. If the plane is not currently attached to any displays, this will beNULL_HANDLE
. -
currentStackIndex
public int currentStackIndex()the current z-order of the plane. This will be between 0 and the value returned byvkGetPhysicalDeviceDisplayPlanePropertiesKHR
inpPropertyCount
. -
malloc
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withBufferUtils
. -
create
Returns a newVkDisplayPlanePropertiesKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkDisplayPlanePropertiesKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
ncurrentDisplay
public static long ncurrentDisplay(long struct) Unsafe version ofcurrentDisplay()
. -
ncurrentStackIndex
public static int ncurrentStackIndex(long struct) Unsafe version ofcurrentStackIndex()
.
-