Package org.lwjgl.vulkan
Class VkDisplayModeParametersKHR
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkDisplayModeParametersKHR
extends Struct<VkDisplayModeParametersKHR>
implements NativeResource
Structure describing display parameters associated with a display mode.
Description
Note
For example, a 60Hz display mode would report a refreshRate
of 60,000.
Valid Usage
- The
width
member ofvisibleRegion
must be greater than 0 - The
height
member ofvisibleRegion
must be greater than 0 refreshRate
must be greater than 0
See Also
VkDisplayModeCreateInfoKHR
, VkDisplayModePropertiesKHR
, VkExtent2D
Layout
struct VkDisplayModeParametersKHR {
VkExtent2D
visibleRegion()
;
uint32_t refreshRate()
;
}
-
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 size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkDisplayModeParametersKHR
(ByteBuffer container) Creates aVkDisplayModeParametersKHR
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkDisplayModeParametersKHR
calloc()
Returns a newVkDisplayModeParametersKHR
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayModeParametersKHR
calloc
(MemoryStack stack) Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayModeParametersKHR
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkDisplayModeParametersKHR
callocStack
(MemoryStack stack) Deprecated.static VkDisplayModeParametersKHR
create()
Returns a newVkDisplayModeParametersKHR
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayModeParametersKHR
create
(long address) Returns a newVkDisplayModeParametersKHR
instance for the specified memory address.create
(long address, int capacity) Create aVkDisplayModeParametersKHR.Buffer
instance at the specified memory.static VkDisplayModeParametersKHR
createSafe
(long address) createSafe
(long address, int capacity) static VkDisplayModeParametersKHR
malloc()
Returns a newVkDisplayModeParametersKHR
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayModeParametersKHR
malloc
(MemoryStack stack) Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
.static VkDisplayModeParametersKHR
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkDisplayModeParametersKHR
mallocStack
(MemoryStack stack) Deprecated.static int
nrefreshRate
(long struct) Unsafe version ofrefreshRate()
.static void
nrefreshRate
(long struct, int value) Unsafe version ofrefreshRate
.static VkExtent2D
nvisibleRegion
(long struct) Unsafe version ofvisibleRegion()
.static void
nvisibleRegion
(long struct, VkExtent2D value) Unsafe version ofvisibleRegion
.int
auint32_t
that is the number of times the display is refreshed each second multiplied by 1000.refreshRate
(int value) Sets the specified value to therefreshRate()
field.Copies the specified struct data to this struct.set
(VkExtent2D visibleRegion, int refreshRate) Initializes this struct with the specified values.int
sizeof()
Returnssizeof(struct)
.the 2D extents of the visible region.visibleRegion
(Consumer<VkExtent2D> consumer) Passes thevisibleRegion()
field to the specifiedConsumer
.visibleRegion
(VkExtent2D value) Copies the specifiedVkExtent2D
to thevisibleRegion()
field.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. -
VISIBLEREGION
public static final int VISIBLEREGIONThe struct member offsets. -
REFRESHRATE
public static final int REFRESHRATEThe struct member offsets.
-
-
Constructor Details
-
VkDisplayModeParametersKHR
Creates aVkDisplayModeParametersKHR
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<VkDisplayModeParametersKHR>
-
visibleRegion
the 2D extents of the visible region. -
refreshRate
public int refreshRate()auint32_t
that is the number of times the display is refreshed each second multiplied by 1000. -
visibleRegion
Copies the specifiedVkExtent2D
to thevisibleRegion()
field. -
visibleRegion
Passes thevisibleRegion()
field to the specifiedConsumer
. -
refreshRate
Sets the specified value to therefreshRate()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkDisplayModeParametersKHR
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkDisplayModeParametersKHR
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkDisplayModeParametersKHR
instance allocated withBufferUtils
. -
create
Returns a newVkDisplayModeParametersKHR
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkDisplayModeParametersKHR.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 VkDisplayModeParametersKHR.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nvisibleRegion
Unsafe version ofvisibleRegion()
. -
nrefreshRate
public static int nrefreshRate(long struct) Unsafe version ofrefreshRate()
. -
nvisibleRegion
Unsafe version ofvisibleRegion
. -
nrefreshRate
public static void nrefreshRate(long struct, int value) Unsafe version ofrefreshRate
.
-