Package org.lwjgl.vulkan

Class VkDisplayModeCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayModeCreateInfoKHR>

org.lwjgl.vulkan.VkDisplayModeCreateInfoKHR

All Implemented Interfaces:

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

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

Structure specifying parameters of a newly created display mode object.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
• pNext must be NULL
• flags must be 0
• parameters must be a valid VkDisplayModeParametersKHR structure

See Also

VkDisplayModeParametersKHR, CreateDisplayModeKHR

Layout

 struct VkDisplayModeCreateInfoKHR {
     VkStructureType sType();
     void const * pNext();
     VkDisplayModeCreateFlagsKHR flags();
     VkDisplayModeParametersKHR parameters();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDisplayModeCreateInfoKHR.Buffer	An array of VkDisplayModeCreateInfoKHR 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	FLAGS	The struct member offsets.
static final int	PARAMETERS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	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
VkDisplayModeCreateInfoKHR(ByteBuffer container)	Creates a VkDisplayModeCreateInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDisplayModeCreateInfoKHR	calloc()	Returns a new VkDisplayModeCreateInfoKHR instance allocated with memCalloc.
static VkDisplayModeCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkDisplayModeCreateInfoKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayModeCreateInfoKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModeCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayModeCreateInfoKHR	callocStack()	Deprecated.
static VkDisplayModeCreateInfoKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayModeCreateInfoKHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayModeCreateInfoKHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayModeCreateInfoKHR	create()	Returns a new VkDisplayModeCreateInfoKHR instance allocated with BufferUtils.
static VkDisplayModeCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkDisplayModeCreateInfoKHR	create(long address)	Returns a new VkDisplayModeCreateInfoKHR instance for the specified memory address.
static VkDisplayModeCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkDisplayModeCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkDisplayModeCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayModeCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	reserved for future use, and must be zero.
VkDisplayModeCreateInfoKHR	flags(int value)	Sets the specified value to the flags() field.
static VkDisplayModeCreateInfoKHR	malloc()	Returns a new VkDisplayModeCreateInfoKHR instance allocated with memAlloc.
static VkDisplayModeCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkDisplayModeCreateInfoKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplayModeCreateInfoKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDisplayModeCreateInfoKHR instance allocated on the specified MemoryStack.
static VkDisplayModeCreateInfoKHR	mallocStack()	Deprecated.
static VkDisplayModeCreateInfoKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayModeCreateInfoKHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDisplayModeCreateInfoKHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static VkDisplayModeParametersKHR	nparameters(long struct)	Unsafe version of parameters().
static void	nparameters(long struct, VkDisplayModeParametersKHR value)	Unsafe version of parameters.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
VkDisplayModeParametersKHR	parameters()	a VkDisplayModeParametersKHR structure describing the display parameters to use in creating the new mode.
VkDisplayModeCreateInfoKHR	parameters(Consumer<VkDisplayModeParametersKHR> consumer)	Passes the parameters() field to the specified Consumer.
VkDisplayModeCreateInfoKHR	parameters(VkDisplayModeParametersKHR value)	Copies the specified VkDisplayModeParametersKHR to the parameters() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDisplayModeCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkDisplayModeCreateInfoKHR	set(int sType, long pNext, int flags, VkDisplayModeParametersKHR parameters)	Initializes this struct with the specified values.
VkDisplayModeCreateInfoKHR	set(VkDisplayModeCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDisplayModeCreateInfoKHR	sType(int value)	Sets the specified value to the sType() field.
VkDisplayModeCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR value to the sType() 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

PARAMETERS

public static final int PARAMETERS

The struct member offsets.

Constructor Details

VkDisplayModeCreateInfoKHR

public VkDisplayModeCreateInfoKHR(ByteBuffer container)

Creates a VkDisplayModeCreateInfoKHR 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<VkDisplayModeCreateInfoKHR>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

reserved for future use, and must be zero.

parameters

public VkDisplayModeParametersKHR parameters()

a VkDisplayModeParametersKHR structure describing the display parameters to use in creating the new mode. If the parameters are not compatible with the specified display, the implementation must return ERROR_INITIALIZATION_FAILED.

sType

public VkDisplayModeCreateInfoKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDisplayModeCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR value to the sType() field.

pNext

public VkDisplayModeCreateInfoKHR pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkDisplayModeCreateInfoKHR flags(int value)

Sets the specified value to the flags() field.

parameters

public VkDisplayModeCreateInfoKHR parameters(VkDisplayModeParametersKHR value)

Copies the specified VkDisplayModeParametersKHR to the parameters() field.

parameters

public VkDisplayModeCreateInfoKHR parameters(Consumer<VkDisplayModeParametersKHR> consumer)

Passes the parameters() field to the specified Consumer.

set

public VkDisplayModeCreateInfoKHR set(int sType,
 long pNext,
 int flags,
 VkDisplayModeParametersKHR parameters)

Initializes this struct with the specified values.

set

public VkDisplayModeCreateInfoKHR set(VkDisplayModeCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplayModeCreateInfoKHR malloc()

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

calloc

public static VkDisplayModeCreateInfoKHR calloc()

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

create

public static VkDisplayModeCreateInfoKHR create()

Returns a new VkDisplayModeCreateInfoKHR instance allocated with BufferUtils.

create

public static VkDisplayModeCreateInfoKHR create(long address)

Returns a new VkDisplayModeCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayModeCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayModeCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayModeCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayModeCreateInfoKHR.Buffer create(int capacity)

Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayModeCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayModeCreateInfoKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayModeCreateInfoKHR callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayModeCreateInfoKHR.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 VkDisplayModeCreateInfoKHR.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 VkDisplayModeCreateInfoKHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDisplayModeCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nparameters

public static VkDisplayModeParametersKHR nparameters(long struct)

Unsafe version of parameters().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nparameters

public static void nparameters(long struct,
 VkDisplayModeParametersKHR value)

Unsafe version of parameters.