Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDisplayModeParametersKHR

extends Struct<VkDisplayModeParametersKHR>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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
See Also

VkDisplayModeCreateInfoKHR, VkDisplayModePropertiesKHR, VkExtent2D

Layout


struct VkDisplayModeParametersKHR {
    VkExtent2D visibleRegion;
    uint32_t refreshRate;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
REFRESHRATE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
VISIBLEREGION

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDisplayModeParametersKHR(long address, ByteBuffer container)

public
VkDisplayModeParametersKHR(ByteBuffer container)

Creates a VkDisplayModeParametersKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDisplayModeParametersKHR
calloc()

Returns a new VkDisplayModeParametersKHR instance allocated with memCalloc.

public static VkDisplayModeParametersKHR.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with memCalloc.

public static VkDisplayModeParametersKHR
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDisplayModeParametersKHR.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDisplayModeParametersKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayModeParametersKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayModeParametersKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayModeParametersKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDisplayModeParametersKHR
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDisplayModeParametersKHR
create()

Returns a new VkDisplayModeParametersKHR instance allocated with BufferUtils.

public static VkDisplayModeParametersKHR
create(long address)

Returns a new VkDisplayModeParametersKHR instance for the specified memory address.

public static VkDisplayModeParametersKHR.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with BufferUtils.

public static VkDisplayModeParametersKHR.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkDisplayModeParametersKHR.Buffer instance at the specified memory.

public static VkDisplayModeParametersKHR
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDisplayModeParametersKHR.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkDisplayModeParametersKHR
malloc()

Returns a new VkDisplayModeParametersKHR instance allocated with memAlloc.

public static VkDisplayModeParametersKHR.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with memAlloc.

public static VkDisplayModeParametersKHR
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack.

public static VkDisplayModeParametersKHR.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated on the specified MemoryStack.

public static VkDisplayModeParametersKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayModeParametersKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayModeParametersKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDisplayModeParametersKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nrefreshRate(long struct)

Unsafe version of refreshRate.

public static void
nrefreshRate(long struct, int value)

Unsafe version of refreshRate.

public static VkExtent2D
nvisibleRegion(long struct)

Unsafe version of visibleRegion.

public static void
nvisibleRegion(long struct, VkExtent2D value)

Unsafe version of visibleRegion.

public int
refreshRate()

a uint32_t that is the number of times the display is refreshed each second multiplied by 1000.

public VkDisplayModeParametersKHR
refreshRate(int value)

Sets the specified value to the refreshRate field.

public VkDisplayModeParametersKHR
set(VkExtent2D visibleRegion, int refreshRate)

Initializes this struct with the specified values.

public VkDisplayModeParametersKHR

Returns:

this struct
set
(VkDisplayModeParametersKHR
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public VkExtent2D
visibleRegion()

the 2D extents of the visible region.

public VkDisplayModeParametersKHR
visibleRegion(VkExtent2D value)

Copies the specified VkExtent2D to the visibleRegion field.

public VkDisplayModeParametersKHR
visibleRegion(Consumer<VkExtent2D> consumer)

Passes the visibleRegion field to the specified Consumer.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

REFRESHRATEback to summary
public static final int REFRESHRATE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

VISIBLEREGIONback to summary
public static final int VISIBLEREGION

The struct member offsets.

Constructor Detail

VkDisplayModeParametersKHRback to summary
protected VkDisplayModeParametersKHR(long address, ByteBuffer container)
VkDisplayModeParametersKHRback to summary
public VkDisplayModeParametersKHR(ByteBuffer container)

Creates a VkDisplayModeParametersKHR instance at the current position of the specified ByteBuffer 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

callocback to summary
public static VkDisplayModeParametersKHR calloc()

Returns a new VkDisplayModeParametersKHR instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkDisplayModeParametersKHR.Buffer calloc(int capacity)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDisplayModeParametersKHR calloc(MemoryStack stack)

Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDisplayModeParametersKHR.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDisplayModeParametersKHR callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayModeParametersKHR callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkDisplayModeParametersKHR create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDisplayModeParametersKHR create()

Returns a new VkDisplayModeParametersKHR instance allocated with BufferUtils.

createback to summary
public static VkDisplayModeParametersKHR create(long address)

Returns a new VkDisplayModeParametersKHR instance for the specified memory address.

createback to summary
public static VkDisplayModeParametersKHR.Buffer create(int capacity)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDisplayModeParametersKHR.Buffer create(long address, int capacity)

Create a VkDisplayModeParametersKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDisplayModeParametersKHR createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDisplayModeParametersKHR.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDisplayModeParametersKHR malloc()

Returns a new VkDisplayModeParametersKHR instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkDisplayModeParametersKHR.Buffer malloc(int capacity)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDisplayModeParametersKHR malloc(MemoryStack stack)

Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDisplayModeParametersKHR.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDisplayModeParametersKHR mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDisplayModeParametersKHR mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDisplayModeParametersKHR.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDisplayModeParametersKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nrefreshRateback to summary
public static int nrefreshRate(long struct)

Unsafe version of refreshRate.

nrefreshRateback to summary
public static void nrefreshRate(long struct, int value)

Unsafe version of refreshRate.

nvisibleRegionback to summary
public static VkExtent2D nvisibleRegion(long struct)

Unsafe version of visibleRegion.

nvisibleRegionback to summary
public static void nvisibleRegion(long struct, VkExtent2D value)

Unsafe version of visibleRegion.

refreshRateback to summary
public int refreshRate()

a uint32_t that is the number of times the display is refreshed each second multiplied by 1000.

Annotations
@NativeType:uint32_t
refreshRateback to summary
public VkDisplayModeParametersKHR refreshRate(int value)

Sets the specified value to the refreshRate field.

setback to summary
public VkDisplayModeParametersKHR set(VkExtent2D visibleRegion, int refreshRate)

Initializes this struct with the specified values.

setback to summary
public VkDisplayModeParametersKHR set(VkDisplayModeParametersKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDisplayModeParametersKHR

the source struct

Returns:VkDisplayModeParametersKHR

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
visibleRegionback to summary
public VkExtent2D visibleRegion()

the 2D extents of the visible region.

visibleRegionback to summary
public VkDisplayModeParametersKHR visibleRegion(VkExtent2D value)

Copies the specified VkExtent2D to the visibleRegion field.

visibleRegionback to summary
public VkDisplayModeParametersKHR visibleRegion(Consumer<VkExtent2D> consumer)

Passes the visibleRegion field to the specified Consumer.

org.lwjgl.vulkan back to summary

public Class VkDisplayModeParametersKHR.Buffer

extends StructBuffer<VkDisplayModeParametersKHR, VkDisplayModeParametersKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkDisplayModeParametersKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDisplayModeParametersKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDisplayModeParametersKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkDisplayModeParametersKHR
public int

Returns:

the value of the VkDisplayModeParametersKHR#refreshRate field.
refreshRate
()

public VkDisplayModeParametersKHR.Buffer
refreshRate(int value)

Sets the specified value to the VkDisplayModeParametersKHR#refreshRate field.

protected VkDisplayModeParametersKHR.Buffer
public VkExtent2D
public VkDisplayModeParametersKHR.Buffer
public VkDisplayModeParametersKHR.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDisplayModeParametersKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDisplayModeParametersKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDisplayModeParametersKHR#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkDisplayModeParametersKHR getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
refreshRateback to summary
public int refreshRate()
Returns:int

the value of the VkDisplayModeParametersKHR#refreshRate field.

Annotations
@NativeType:uint32_t
refreshRateback to summary
public VkDisplayModeParametersKHR.Buffer refreshRate(int value)

Sets the specified value to the VkDisplayModeParametersKHR#refreshRate field.

selfback to summary
protected VkDisplayModeParametersKHR.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
visibleRegionback to summary
public VkExtent2D visibleRegion()
Returns:VkExtent2D

a VkExtent2D view of the VkDisplayModeParametersKHR#visibleRegion field.

visibleRegionback to summary
public VkDisplayModeParametersKHR.Buffer visibleRegion(VkExtent2D value)

Copies the specified VkExtent2D to the VkDisplayModeParametersKHR#visibleRegion field.

visibleRegionback to summary
public VkDisplayModeParametersKHR.Buffer visibleRegion(Consumer<VkExtent2D> consumer)

Passes the VkDisplayModeParametersKHR#visibleRegion field to the specified Consumer.