Package org.lwjgl.vulkan
Class VkDisplayPropertiesKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayPropertiesKHR
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDisplayPropertiesKHR extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes properties of a display device present on a Vulkan physical device.
Valid Usage
display
must be a validVkDisplayKHR
handledisplayName
must be a null-terminated stringsupportedTransforms
must be a valid combination ofVkSurfaceTransformFlagBitsKHR
values
Member documentation
display
– a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.displayName
– a pointer to a NULL-terminated string containing the name of the display. Generally, this will be the name provided by the display’s EDID. It can be NULL if no suitable name is available.physicalDimensions
– the physical width and height of the visible portion of the display, in millimetersphysicalResolution
– the physical, native, or preferred resolution of the displaysupportedTransforms
– which transforms are supported by this display. One or more of:planeReorderPossible
– whether the planes on this display can have their z order changed. If this isTRUE
, the application can re-arrange the planes on this display in any order relative to each other.persistentContent
– whether the display supports self-refresh/internal buffering. If this is true, the application can submit persistent present operations on swapchains created against this display.
Layout
struct VkDisplayPropertiesKHR { VkDisplayKHR display; const char * displayName;
VkExtent2D
physicalDimensions;VkExtent2D
physicalResolution; VkSurfaceTransformFlagsKHR supportedTransforms; VkBool32 planeReorderPossible; VkBool32 persistentContent; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkDisplayPropertiesKHR.Buffer
An array ofVkDisplayPropertiesKHR
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 VkDisplayPropertiesKHR(java.nio.ByteBuffer container)
Creates aVkDisplayPropertiesKHR
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 VkDisplayPropertiesKHR
calloc()
Returns a newVkDisplayPropertiesKHR
instance allocated withmemCalloc
.static VkDisplayPropertiesKHR.Buffer
calloc(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated withmemCalloc
.static VkDisplayPropertiesKHR
callocStack()
Returns a newVkDisplayPropertiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPropertiesKHR.Buffer
callocStack(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayPropertiesKHR.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPropertiesKHR
callocStack(MemoryStack stack)
Returns a newVkDisplayPropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayPropertiesKHR
create()
Returns a newVkDisplayPropertiesKHR
instance allocated withBufferUtils
.static VkDisplayPropertiesKHR.Buffer
create(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayPropertiesKHR
create(long address)
Returns a newVkDisplayPropertiesKHR
instance for the specified memory address ornull
if the address isNULL
.static VkDisplayPropertiesKHR.Buffer
create(long address, int capacity)
Create aVkDisplayPropertiesKHR.Buffer
instance at the specified memory.long
display()
Returns the value of thedisplay
field.java.nio.ByteBuffer
displayName()
Returns aByteBuffer
view of the null-terminated string pointed to by thedisplayName
field.java.lang.String
displayNameString()
Decodes the null-terminated string pointed to by thedisplayName
field.static VkDisplayPropertiesKHR
malloc()
Returns a newVkDisplayPropertiesKHR
instance allocated withmemAlloc
.static VkDisplayPropertiesKHR.Buffer
malloc(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated withmemAlloc
.static VkDisplayPropertiesKHR
mallocStack()
Returns a newVkDisplayPropertiesKHR
instance allocated on the thread-localMemoryStack
.static VkDisplayPropertiesKHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplayPropertiesKHR.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayPropertiesKHR
mallocStack(MemoryStack stack)
Returns a newVkDisplayPropertiesKHR
instance allocated on the specifiedMemoryStack
.int
persistentContent()
Returns the value of thepersistentContent
field.VkExtent2D
physicalDimensions()
Returns aVkExtent2D
view of thephysicalDimensions
field.VkExtent2D
physicalResolution()
Returns aVkExtent2D
view of thephysicalResolution
field.int
planeReorderPossible()
Returns the value of theplaneReorderPossible
field.int
sizeof()
Returns thesizeof(struct)
.int
supportedTransforms()
Returns the value of thesupportedTransforms
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
-
VkDisplayPropertiesKHR
public VkDisplayPropertiesKHR(java.nio.ByteBuffer container)
Creates aVkDisplayPropertiesKHR
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)
.
-
display
public long display()
Returns the value of thedisplay
field.
-
displayName
public java.nio.ByteBuffer displayName()
Returns aByteBuffer
view of the null-terminated string pointed to by thedisplayName
field.
-
displayNameString
public java.lang.String displayNameString()
Decodes the null-terminated string pointed to by thedisplayName
field.
-
physicalDimensions
public VkExtent2D physicalDimensions()
Returns aVkExtent2D
view of thephysicalDimensions
field.
-
physicalResolution
public VkExtent2D physicalResolution()
Returns aVkExtent2D
view of thephysicalResolution
field.
-
supportedTransforms
public int supportedTransforms()
Returns the value of thesupportedTransforms
field.
-
planeReorderPossible
public int planeReorderPossible()
Returns the value of theplaneReorderPossible
field.
-
persistentContent
public int persistentContent()
Returns the value of thepersistentContent
field.
-
malloc
public static VkDisplayPropertiesKHR malloc()
Returns a newVkDisplayPropertiesKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplayPropertiesKHR calloc()
Returns a newVkDisplayPropertiesKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplayPropertiesKHR create()
Returns a newVkDisplayPropertiesKHR
instance allocated withBufferUtils
.
-
create
public static VkDisplayPropertiesKHR create(long address)
Returns a newVkDisplayPropertiesKHR
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDisplayPropertiesKHR.Buffer malloc(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplayPropertiesKHR.Buffer calloc(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPropertiesKHR.Buffer create(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayPropertiesKHR.Buffer create(long address, int capacity)
Create aVkDisplayPropertiesKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDisplayPropertiesKHR mallocStack()
Returns a newVkDisplayPropertiesKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplayPropertiesKHR callocStack()
Returns a newVkDisplayPropertiesKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplayPropertiesKHR mallocStack(MemoryStack stack)
Returns a newVkDisplayPropertiesKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayPropertiesKHR callocStack(MemoryStack stack)
Returns a newVkDisplayPropertiesKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDisplayPropertiesKHR.Buffer mallocStack(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplayPropertiesKHR.Buffer callocStack(int capacity)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplayPropertiesKHR.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplayPropertiesKHR.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayPropertiesKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-