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
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDisplayPlanePropertiesKHR extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure describing display plane properties.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. This will be between 0 and the value returned byvkGetPhysicalDeviceDisplayPlanePropertiesKHR
inpPropertyCount
.
Layout
struct VkDisplayPlanePropertiesKHR { VkDisplayKHR currentDisplay; uint32_t currentStackIndex; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDisplayPlanePropertiesKHR.Buffer
An array ofVkDisplayPlanePropertiesKHR
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
CURRENTDISPLAY
CURRENTSTACKINDEXThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor 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 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, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPlanePropertiesKHR
callocStack(org.lwjgl.system.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.static VkDisplayPlanePropertiesKHR.Buffer
create(long address, int capacity)
Create aVkDisplayPlanePropertiesKHR.Buffer
instance at the specified memory.static VkDisplayPlanePropertiesKHR
createSafe(long address)
static VkDisplayPlanePropertiesKHR.Buffer
createSafe(long address, int capacity)
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, org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPlanePropertiesKHR
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
.static long
ncurrentDisplay(long struct)
Unsafe version ofcurrentDisplay()
.static int
ncurrentStackIndex(long struct)
Unsafe version ofcurrentStackIndex()
.int
sizeof()
-
-
-
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()
- Specified by:
sizeof
in classorg.lwjgl.system.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.
-
createSafe
@Nullable public static VkDisplayPlanePropertiesKHR createSafe(long address)
-
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
-
createSafe
@Nullable public static VkDisplayPlanePropertiesKHR.Buffer createSafe(long address, int 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(org.lwjgl.system.MemoryStack stack)
Returns a newVkDisplayPlanePropertiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayPlanePropertiesKHR callocStack(org.lwjgl.system.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, org.lwjgl.system.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, org.lwjgl.system.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
-
ncurrentDisplay
public static long ncurrentDisplay(long struct)
Unsafe version ofcurrentDisplay()
.
-
ncurrentStackIndex
public static int ncurrentStackIndex(long struct)
Unsafe version ofcurrentStackIndex()
.
-
-