Package org.lwjgl.vulkan
Class VkDisplayModeParametersKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayModeParametersKHR
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDisplayModeParametersKHR extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes the display parameters associated a display mode.
Member documentation
visibleRegion
– the 2D extents of the visible regionrefreshRate
– auint32_t
that is the number of times the display is refreshed each second multiplied by 1000
Layout
struct VkDisplayModeParametersKHR {
VkExtent2D
visibleRegion; uint32_t refreshRate; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkDisplayModeParametersKHR.Buffer
An array ofVkDisplayModeParametersKHR
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 VkDisplayModeParametersKHR(java.nio.ByteBuffer container)
Creates aVkDisplayModeParametersKHR
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 VkDisplayModeParametersKHR
calloc()
Returns a newVkDisplayModeParametersKHR
instance allocated withmemCalloc
.static VkDisplayModeParametersKHR.Buffer
calloc(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemCalloc
.static VkDisplayModeParametersKHR
callocStack()
Returns a newVkDisplayModeParametersKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayModeParametersKHR.Buffer
callocStack(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayModeParametersKHR.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayModeParametersKHR
callocStack(MemoryStack stack)
Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayModeParametersKHR
create()
Returns a newVkDisplayModeParametersKHR
instance allocated withBufferUtils
.static VkDisplayModeParametersKHR.Buffer
create(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayModeParametersKHR
create(long address)
Returns a newVkDisplayModeParametersKHR
instance for the specified memory address ornull
if the address isNULL
.static VkDisplayModeParametersKHR.Buffer
create(long address, int capacity)
Create aVkDisplayModeParametersKHR.Buffer
instance at the specified memory.static VkDisplayModeParametersKHR
malloc()
Returns a newVkDisplayModeParametersKHR
instance allocated withmemAlloc
.static VkDisplayModeParametersKHR.Buffer
malloc(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemAlloc
.static VkDisplayModeParametersKHR
mallocStack()
Returns a newVkDisplayModeParametersKHR
instance allocated on the thread-localMemoryStack
.static VkDisplayModeParametersKHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplayModeParametersKHR.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayModeParametersKHR
mallocStack(MemoryStack stack)
Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
.VkDisplayModeParametersKHR
nset(long struct)
Unsafe version ofset
.int
refreshRate()
Returns the value of therefreshRate
field.VkDisplayModeParametersKHR
refreshRate(int value)
Sets the specified value to therefreshRate
field.VkDisplayModeParametersKHR
set(VkDisplayModeParametersKHR src)
Copies the specified struct data to this struct.VkDisplayModeParametersKHR
set(VkExtent2D visibleRegion, int refreshRate)
Initializes this struct with the specified values.int
sizeof()
Returns thesizeof(struct)
.VkExtent2D
visibleRegion()
Returns aVkExtent2D
view of thevisibleRegion
field.VkDisplayModeParametersKHR
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
-
-
-
-
Constructor Detail
-
VkDisplayModeParametersKHR
public VkDisplayModeParametersKHR(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
visibleRegion
public VkExtent2D visibleRegion()
Returns aVkExtent2D
view of thevisibleRegion
field.
-
refreshRate
public int refreshRate()
Returns the value of therefreshRate
field.
-
visibleRegion
public VkDisplayModeParametersKHR visibleRegion(VkExtent2D value)
Copies the specifiedVkExtent2D
to thevisibleRegion
field.
-
refreshRate
public VkDisplayModeParametersKHR refreshRate(int value)
Sets the specified value to therefreshRate
field.
-
set
public VkDisplayModeParametersKHR set(VkExtent2D visibleRegion, int refreshRate)
Initializes this struct with the specified values.
-
nset
public VkDisplayModeParametersKHR nset(long struct)
Unsafe version ofset
.
-
set
public VkDisplayModeParametersKHR set(VkDisplayModeParametersKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDisplayModeParametersKHR malloc()
Returns a newVkDisplayModeParametersKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplayModeParametersKHR calloc()
Returns a newVkDisplayModeParametersKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplayModeParametersKHR create()
Returns a newVkDisplayModeParametersKHR
instance allocated withBufferUtils
.
-
create
public static VkDisplayModeParametersKHR create(long address)
Returns a newVkDisplayModeParametersKHR
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDisplayModeParametersKHR.Buffer malloc(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplayModeParametersKHR.Buffer calloc(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayModeParametersKHR.Buffer create(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayModeParametersKHR.Buffer create(long address, int capacity)
Create aVkDisplayModeParametersKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDisplayModeParametersKHR mallocStack()
Returns a newVkDisplayModeParametersKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplayModeParametersKHR callocStack()
Returns a newVkDisplayModeParametersKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplayModeParametersKHR mallocStack(MemoryStack stack)
Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayModeParametersKHR callocStack(MemoryStack stack)
Returns a newVkDisplayModeParametersKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDisplayModeParametersKHR.Buffer mallocStack(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplayModeParametersKHR.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeParametersKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-