Package org.lwjgl.vulkan
Class VkDisplayPlanePropertiesKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayPlanePropertiesKHR
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDisplayPlanePropertiesKHR extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes properties of a display plane.
Valid Usage
currentDisplay
must be a validVkDisplayKHR
handle
Member documentation
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
– the current z-order of the plane
Layout
struct VkDisplayPlanePropertiesKHR { VkDisplayKHR currentDisplay; uint32_t currentStackIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkDisplayPlanePropertiesKHR.Buffer
An array ofVkDisplayPlanePropertiesKHR
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 VkDisplayPlanePropertiesKHR(java.nio.ByteBuffer container)
Creates aVkDisplayPlanePropertiesKHR
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 VkDisplayPlanePropertiesKHR
calloc()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemCalloc
.static VkDisplayPlanePropertiesKHR.Buffer
calloc(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemCalloc
.static VkDisplayPlanePropertiesKHR
callocStack()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR.Buffer
callocStack(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR
callocStack(MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR
create()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withBufferUtils
.static VkDisplayPlanePropertiesKHR.Buffer
create(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayPlanePropertiesKHR
create(long address)
Returns a newVkDisplayPlanePropertiesKHR
instance for the specified memory address ornull
if the address isNULL
.static VkDisplayPlanePropertiesKHR.Buffer
create(long address, int capacity)
Create aVkDisplayPlanePropertiesKHR.Buffer
instance at the specified memory.long
currentDisplay()
Returns the value of thecurrentDisplay
field.int
currentStackIndex()
Returns the value of thecurrentStackIndex
field.static VkDisplayPlanePropertiesKHR
malloc()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemAlloc
.static VkDisplayPlanePropertiesKHR.Buffer
malloc(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemAlloc
.static VkDisplayPlanePropertiesKHR
mallocStack()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the thread-localMemoryStack
.static VkDisplayPlanePropertiesKHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplayPlanePropertiesKHR.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPlanePropertiesKHR
mallocStack(MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
.int
sizeof()
Returns thesizeof(struct)
.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkDisplayPlanePropertiesKHR
public VkDisplayPlanePropertiesKHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
currentDisplay
public long currentDisplay()
Returns the value of thecurrentDisplay
field.
-
currentStackIndex
public int currentStackIndex()
Returns the value of thecurrentStackIndex
field.
-
malloc
public static VkDisplayPlanePropertiesKHR malloc()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplayPlanePropertiesKHR calloc()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplayPlanePropertiesKHR create()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated withBufferUtils
.
-
create
public static VkDisplayPlanePropertiesKHR create(long address)
Returns a newVkDisplayPlanePropertiesKHR
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDisplayPlanePropertiesKHR.Buffer malloc(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplayPlanePropertiesKHR.Buffer calloc(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPlanePropertiesKHR.Buffer create(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPlanePropertiesKHR.Buffer create(long address, int capacity)
Create aVkDisplayPlanePropertiesKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDisplayPlanePropertiesKHR mallocStack()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplayPlanePropertiesKHR callocStack()
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplayPlanePropertiesKHR mallocStack(MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayPlanePropertiesKHR callocStack(MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-