Package org.lwjgl.vulkan

Class VkDisplayModePropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayModePropertiesKHR>

org.lwjgl.vulkan.VkDisplayModePropertiesKHR

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDisplayModePropertiesKHR
extends org.lwjgl.system.Struct<VkDisplayModePropertiesKHR>
implements org.lwjgl.system.NativeResource

Structure describing display mode properties.

See Also

VkDisplayModeParametersKHR, VkDisplayModeProperties2KHR, GetDisplayModePropertiesKHR

Layout

 struct VkDisplayModePropertiesKHR {
     VkDisplayModeKHR displayMode();
     VkDisplayModeParametersKHR parameters();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDisplayModePropertiesKHR	calloc()	Returns a new VkDisplayModePropertiesKHR instance allocated with memCalloc.
static VkDisplayModePropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with memCalloc.
static VkDisplayModePropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayModePropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModePropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayModePropertiesKHR	callocStack()	Deprecated.
static VkDisplayModePropertiesKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayModePropertiesKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayModePropertiesKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayModePropertiesKHR	create()	Returns a new VkDisplayModePropertiesKHR instance allocated with BufferUtils.
static VkDisplayModePropertiesKHR.Buffer	create(int capacity)	Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with BufferUtils.
static VkDisplayModePropertiesKHR	create(long address)	Returns a new VkDisplayModePropertiesKHR instance for the specified memory address.
static VkDisplayModePropertiesKHR.Buffer	create(long address, int capacity)	Create a VkDisplayModePropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkDisplayModePropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayModePropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	displayMode()	a handle to the display mode described in this structure.
static VkDisplayModePropertiesKHR	malloc()	Returns a new VkDisplayModePropertiesKHR instance allocated with memAlloc.
static VkDisplayModePropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with memAlloc.
static VkDisplayModePropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplayModePropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModePropertiesKHR instance allocated on the specified MemoryStack.
static VkDisplayModePropertiesKHR	mallocStack()	Deprecated.
static VkDisplayModePropertiesKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayModePropertiesKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayModePropertiesKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	ndisplayMode(long struct)	Unsafe version of displayMode().
static VkDisplayModeParametersKHR	nparameters(long struct)	Unsafe version of parameters().
VkDisplayModeParametersKHR	parameters()	a VkDisplayModeParametersKHR structure describing the display parameters associated with displayMode.
int	sizeof()

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.

DISPLAYMODE

public static final int DISPLAYMODE

The struct member offsets.

PARAMETERS

public static final int PARAMETERS

The struct member offsets.

Constructor Details

VkDisplayModePropertiesKHR

public VkDisplayModePropertiesKHR(ByteBuffer container)

Creates a VkDisplayModePropertiesKHR 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDisplayModePropertiesKHR>

displayMode

public long displayMode()

a handle to the display mode described in this structure. This handle will be valid for the lifetime of the Vulkan instance.

parameters

public VkDisplayModeParametersKHR parameters()

a VkDisplayModeParametersKHR structure describing the display parameters associated with displayMode.

malloc

public static VkDisplayModePropertiesKHR malloc()

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

calloc

public static VkDisplayModePropertiesKHR calloc()

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

create

public static VkDisplayModePropertiesKHR create()

Returns a new VkDisplayModePropertiesKHR instance allocated with BufferUtils.

create

public static VkDisplayModePropertiesKHR create(long address)

Returns a new VkDisplayModePropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayModePropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayModePropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayModePropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayModePropertiesKHR.Buffer create(int capacity)

Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayModePropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayModePropertiesKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModePropertiesKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayModePropertiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModePropertiesKHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayModePropertiesKHR.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModePropertiesKHR.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkDisplayModePropertiesKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDisplayModePropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDisplayModePropertiesKHR calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDisplayModePropertiesKHR.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDisplayModePropertiesKHR.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new VkDisplayModePropertiesKHR.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

ndisplayMode

public static long ndisplayMode(long struct)

Unsafe version of displayMode().

nparameters

public static VkDisplayModeParametersKHR nparameters(long struct)

Unsafe version of parameters().