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, NativeResource, Pointer

public class VkDisplayModeParametersKHR
extends Struct<VkDisplayModeParametersKHR>
implements NativeResource

 struct VkDisplayModeParametersKHR {
     {@link VkExtent2D VkExtent2D} visibleRegion;
     uint32_t refreshRate;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDisplayModeParametersKHR.Buffer	An array of VkDisplayModeParametersKHR structs.

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

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	REFRESHRATE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	VISIBLEREGION	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDisplayModeParametersKHR(ByteBuffer container)	Creates a VkDisplayModeParametersKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDisplayModeParametersKHR	calloc()	Returns a new VkDisplayModeParametersKHR instance allocated with memCalloc.
static VkDisplayModeParametersKHR.Buffer	calloc(int capacity)	Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with memCalloc.
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.
static VkDisplayModeParametersKHR	calloc(MemoryStack stack)	Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayModeParametersKHR	callocStack()	Deprecated.
static VkDisplayModeParametersKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayModeParametersKHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDisplayModeParametersKHR	callocStack(MemoryStack stack)	Deprecated.
static VkDisplayModeParametersKHR	create()	Returns a new VkDisplayModeParametersKHR instance allocated with BufferUtils.
static VkDisplayModeParametersKHR.Buffer	create(int capacity)	Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with BufferUtils.
static VkDisplayModeParametersKHR	create(long address)	Returns a new VkDisplayModeParametersKHR instance for the specified memory address.
static VkDisplayModeParametersKHR.Buffer	create(long address, int capacity)	Create a VkDisplayModeParametersKHR.Buffer instance at the specified memory.
static @Nullable VkDisplayModeParametersKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayModeParametersKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDisplayModeParametersKHR	malloc()	Returns a new VkDisplayModeParametersKHR instance allocated with memAlloc.
static VkDisplayModeParametersKHR.Buffer	malloc(int capacity)	Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with memAlloc.
static VkDisplayModeParametersKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDisplayModeParametersKHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplayModeParametersKHR	malloc(MemoryStack stack)	Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack.
static VkDisplayModeParametersKHR	mallocStack()	Deprecated.
static VkDisplayModeParametersKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayModeParametersKHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDisplayModeParametersKHR	mallocStack(MemoryStack stack)	Deprecated.
static int	nrefreshRate(long struct)	Unsafe version of refreshRate().
static void	nrefreshRate(long struct, int value)	Unsafe version of refreshRate.
static VkExtent2D	nvisibleRegion(long struct)	Unsafe version of visibleRegion().
static void	nvisibleRegion(long struct, VkExtent2D value)	Unsafe version of visibleRegion.
int	refreshRate()
VkDisplayModeParametersKHR	refreshRate(int value)	Sets the specified value to the refreshRate 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 sizeof(struct).
VkExtent2D	visibleRegion()
VkDisplayModeParametersKHR	visibleRegion(Consumer<VkExtent2D> consumer)	Passes the visibleRegion field to the specified Consumer.
VkDisplayModeParametersKHR	visibleRegion(VkExtent2D value)	Copies the specified VkExtent2D to the visibleRegion field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

VISIBLEREGION

public static final int VISIBLEREGION

The struct member offsets.

REFRESHRATE

public static final int REFRESHRATE

The struct member offsets.

Constructor Details

VkDisplayModeParametersKHR

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDisplayModeParametersKHR>

visibleRegion

public VkExtent2D visibleRegion()

Returns:

a VkExtent2D view of the visibleRegion field.

refreshRate

public int refreshRate()

Returns:

the value of the refreshRate field.

visibleRegion

public VkDisplayModeParametersKHR visibleRegion(VkExtent2D value)

Copies the specified VkExtent2D to the visibleRegion field.

visibleRegion

public VkDisplayModeParametersKHR visibleRegion(Consumer<VkExtent2D> consumer)

Passes the visibleRegion field to the specified Consumer.

refreshRate

public VkDisplayModeParametersKHR refreshRate(int value)

Sets the specified value to the refreshRate field.

set

public VkDisplayModeParametersKHR set(VkExtent2D visibleRegion,
 int refreshRate)

Initializes this struct with the specified values.

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 new VkDisplayModeParametersKHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkDisplayModeParametersKHR calloc()

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

create

public static VkDisplayModeParametersKHR create()

Returns a new VkDisplayModeParametersKHR instance allocated with BufferUtils.

create

public static VkDisplayModeParametersKHR create(long address)

Returns a new VkDisplayModeParametersKHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayModeParametersKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayModeParametersKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayModeParametersKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayModeParametersKHR.Buffer create(int capacity)

Returns a new VkDisplayModeParametersKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayModeParametersKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayModeParametersKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModeParametersKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayModeParametersKHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModeParametersKHR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayModeParametersKHR.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayModeParametersKHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModeParametersKHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkDisplayModeParametersKHR malloc(MemoryStack stack)

Returns a new VkDisplayModeParametersKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nvisibleRegion

public static VkExtent2D nvisibleRegion(long struct)

Unsafe version of visibleRegion().

nrefreshRate

public static int nrefreshRate(long struct)

Unsafe version of refreshRate().

nvisibleRegion

public static void nvisibleRegion(long struct,
 VkExtent2D value)

Unsafe version of visibleRegion.

nrefreshRate

public static void nrefreshRate(long struct,
 int value)

Unsafe version of refreshRate.