Package org.lwjgl.vulkan
Class VkDisplayModeParametersKHR
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDisplayModeParametersKHR>
org.lwjgl.vulkan.VkDisplayModeParametersKHR
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDisplayModeParametersKHR
extends org.lwjgl.system.Struct<VkDisplayModeParametersKHR>
implements org.lwjgl.system.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
widthmember ofvisibleRegionmust be greater than 0 - The
heightmember ofvisibleRegionmust be greater than 0 refreshRatemust be greater than 0
See Also
VkDisplayModeCreateInfoKHR, VkDisplayModePropertiesKHR, VkExtent2D
Layout
struct VkDisplayModeParametersKHR {
VkExtent2D visibleRegion();
uint32_t refreshRate();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkDisplayModeParametersKHR(ByteBuffer container) Creates aVkDisplayModeParametersKHRinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkDisplayModeParametersKHRcalloc()Returns a newVkDisplayModeParametersKHRinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDisplayModeParametersKHRcalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayModeParametersKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDisplayModeParametersKHRDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkDisplayModeParametersKHRcallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkDisplayModeParametersKHRcreate()Returns a newVkDisplayModeParametersKHRinstance allocated withBufferUtils.create(int capacity) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated withBufferUtils.static VkDisplayModeParametersKHRcreate(long address) Returns a newVkDisplayModeParametersKHRinstance for the specified memory address.create(long address, int capacity) Create aVkDisplayModeParametersKHR.Bufferinstance at the specified memory.static @Nullable VkDisplayModeParametersKHRcreateSafe(long address) static @Nullable VkDisplayModeParametersKHR.BuffercreateSafe(long address, int capacity) static VkDisplayModeParametersKHRmalloc()Returns a newVkDisplayModeParametersKHRinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated on the specifiedMemoryStack.static VkDisplayModeParametersKHRmalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayModeParametersKHRinstance allocated on the specifiedMemoryStack.static VkDisplayModeParametersKHRDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkDisplayModeParametersKHRmallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intnrefreshRate(long struct) Unsafe version ofrefreshRate().static voidnrefreshRate(long struct, int value) Unsafe version ofrefreshRate.static VkExtent2DnvisibleRegion(long struct) Unsafe version ofvisibleRegion().static voidnvisibleRegion(long struct, VkExtent2D value) Unsafe version ofvisibleRegion.intauint32_tthat 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.intsizeof()the 2D extents of the visible region.visibleRegion(Consumer<VkExtent2D> consumer) Passes thevisibleRegion()field to the specifiedConsumer.visibleRegion(VkExtent2D value) Copies the specifiedVkExtent2Dto thevisibleRegion()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods 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 aVkDisplayModeParametersKHRinstance at the current position of the specifiedByteBuffercontainer. 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()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkDisplayModeParametersKHR>
-
visibleRegion
the 2D extents of the visible region. -
refreshRate
public int refreshRate()auint32_tthat is the number of times the display is refreshed each second multiplied by 1000. -
visibleRegion
Copies the specifiedVkExtent2Dto 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 newVkDisplayModeParametersKHRinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkDisplayModeParametersKHRinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkDisplayModeParametersKHRinstance allocated withBufferUtils. -
create
Returns a newVkDisplayModeParametersKHRinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkDisplayModeParametersKHR.Bufferinstance 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 public static VkDisplayModeParametersKHR mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkDisplayModeParametersKHR callocStack(org.lwjgl.system.MemoryStack stack) 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, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkDisplayModeParametersKHRinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkDisplayModeParametersKHRinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDisplayModeParametersKHR.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkDisplayModeParametersKHR.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkDisplayModeParametersKHR.Bufferinstance allocated on the specifiedMemoryStackand 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.
-