Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDisplayModeCreateInfoKHR

extends Struct<VkDisplayModeCreateInfoKHR>
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 specifying parameters of a newly created display mode object.
Valid Usage (Implicit)
See Also

VkDisplayModeParametersKHR, CreateDisplayModeKHR

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDisplayModeCreateInfoKHR.Buffer

An array of VkDisplayModeCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FLAGS

The struct member offsets.

public static final int
PARAMETERS

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkDisplayModeCreateInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDisplayModeCreateInfoKHR
calloc()

Returns a new VkDisplayModeCreateInfoKHR instance allocated with memCalloc.

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

Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDisplayModeCreateInfoKHR
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkDisplayModeCreateInfoKHR
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 VkDisplayModeCreateInfoKHR
create()

Returns a new VkDisplayModeCreateInfoKHR instance allocated with BufferUtils.

public static VkDisplayModeCreateInfoKHR
create(long address)

Returns a new VkDisplayModeCreateInfoKHR instance for the specified memory address.

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

Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkDisplayModeCreateInfoKHR.Buffer instance at the specified memory.

public static VkDisplayModeCreateInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use, and must be zero.

public VkDisplayModeCreateInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkDisplayModeCreateInfoKHR
malloc()

Returns a new VkDisplayModeCreateInfoKHR instance allocated with memAlloc.

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

Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkDisplayModeCreateInfoKHR instance allocated on the specified MemoryStack.

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

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

public static VkDisplayModeCreateInfoKHR
mallocStack()

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

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

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

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

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

public static VkDisplayModeParametersKHR
nparameters(long struct)

Unsafe version of parameters.

public static void
nparameters(long struct, VkDisplayModeParametersKHR value)

Unsafe version of parameters.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public VkDisplayModeParametersKHR
parameters()

a VkDisplayModeParametersKHR structure describing the display parameters to use in creating the new mode.

public VkDisplayModeCreateInfoKHR
parameters(VkDisplayModeParametersKHR value)

Copies the specified VkDisplayModeParametersKHR to the parameters field.

public VkDisplayModeCreateInfoKHR
parameters(Consumer<VkDisplayModeParametersKHR> consumer)

Passes the parameters field to the specified Consumer.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDisplayModeCreateInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkDisplayModeCreateInfoKHR

Returns:

this struct
set(VkDisplayModeCreateInfoKHR
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 int
sType()

a VkStructureType value identifying this structure.

public VkDisplayModeCreateInfoKHR
sType(int value)

Sets the specified value to the sType field.

public VkDisplayModeCreateInfoKHR
sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR value to the sType field.

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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

PARAMETERSback to summary
public static final int PARAMETERS

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkDisplayModeCreateInfoKHRback to summary
protected VkDisplayModeCreateInfoKHR(long address, ByteBuffer container)
VkDisplayModeCreateInfoKHRback to summary
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 Detail

callocback to summary
public static VkDisplayModeCreateInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDisplayModeCreateInfoKHR calloc(MemoryStack stack)

Returns a new VkDisplayModeCreateInfoKHR 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 VkDisplayModeCreateInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDisplayModeCreateInfoKHR.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 VkDisplayModeCreateInfoKHR 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 VkDisplayModeCreateInfoKHR create()

Returns a new VkDisplayModeCreateInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkDisplayModeCreateInfoKHR create(long address)

Returns a new VkDisplayModeCreateInfoKHR instance for the specified memory address.

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

Returns a new VkDisplayModeCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDisplayModeCreateInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDisplayModeCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

reserved for future use, and must be zero.

Annotations
@NativeType:VkDisplayModeCreateFlagsKHR
flagsback to summary
public VkDisplayModeCreateInfoKHR flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkDisplayModeCreateInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDisplayModeCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkDisplayModeCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

nparametersback to summary
public static VkDisplayModeParametersKHR nparameters(long struct)

Unsafe version of parameters.

nparametersback to summary
public static void nparameters(long struct, VkDisplayModeParametersKHR value)

Unsafe version of parameters.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

parametersback to summary
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.

parametersback to summary
public VkDisplayModeCreateInfoKHR parameters(VkDisplayModeParametersKHR value)

Copies the specified VkDisplayModeParametersKHR to the parameters field.

parametersback to summary
public VkDisplayModeCreateInfoKHR parameters(Consumer<VkDisplayModeParametersKHR> consumer)

Passes the parameters field to the specified Consumer.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkDisplayModeCreateInfoKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkDisplayModeCreateInfoKHR set(VkDisplayModeCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkDisplayModeCreateInfoKHR

the source struct

Returns:VkDisplayModeCreateInfoKHR

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDisplayModeCreateInfoKHR sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkDisplayModeCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDisplayModeCreateInfoKHR.Buffer

extends StructBuffer<VkDisplayModeCreateInfoKHR, VkDisplayModeCreateInfoKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkDisplayModeCreateInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDisplayModeCreateInfoKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDisplayModeCreateInfoKHR.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
public int

Returns:

the value of the VkDisplayModeCreateInfoKHR#flags field.
flags()

public VkDisplayModeCreateInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkDisplayModeCreateInfoKHR#flags field.

protected VkDisplayModeCreateInfoKHR
getElementFactory()

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

public VkDisplayModeParametersKHR

Returns:

a VkDisplayModeParametersKHR view of the VkDisplayModeCreateInfoKHR#parameters field.
parameters()

public VkDisplayModeCreateInfoKHR.Buffer
parameters(VkDisplayModeParametersKHR value)

Copies the specified VkDisplayModeParametersKHR to the VkDisplayModeCreateInfoKHR#parameters field.

public VkDisplayModeCreateInfoKHR.Buffer
parameters(Consumer<VkDisplayModeParametersKHR> consumer)

Passes the VkDisplayModeCreateInfoKHR#parameters field to the specified Consumer.

public long

Returns:

the value of the VkDisplayModeCreateInfoKHR#pNext field.
pNext()

public VkDisplayModeCreateInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkDisplayModeCreateInfoKHR#pNext field.

protected VkDisplayModeCreateInfoKHR.Buffer
self()

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

public int

Returns:

the value of the VkDisplayModeCreateInfoKHR#sType field.
sType()

public VkDisplayModeCreateInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkDisplayModeCreateInfoKHR#sType field.

public VkDisplayModeCreateInfoKHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR value to the VkDisplayModeCreateInfoKHR#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDisplayModeCreateInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the VkDisplayModeCreateInfoKHR#flags field.

Annotations
@NativeType:VkDisplayModeCreateFlagsKHR
flagsback to summary
public VkDisplayModeCreateInfoKHR.Buffer flags(int value)

Sets the specified value to the VkDisplayModeCreateInfoKHR#flags field.

getElementFactoryback to summary
protected VkDisplayModeCreateInfoKHR getElementFactory()

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

Annotations
@Override
parametersback to summary
public VkDisplayModeParametersKHR parameters()
Returns:VkDisplayModeParametersKHR

a VkDisplayModeParametersKHR view of the VkDisplayModeCreateInfoKHR#parameters field.

parametersback to summary
public VkDisplayModeCreateInfoKHR.Buffer parameters(VkDisplayModeParametersKHR value)

Copies the specified VkDisplayModeParametersKHR to the VkDisplayModeCreateInfoKHR#parameters field.

parametersback to summary
public VkDisplayModeCreateInfoKHR.Buffer parameters(Consumer<VkDisplayModeParametersKHR> consumer)

Passes the VkDisplayModeCreateInfoKHR#parameters field to the specified Consumer.

pNextback to summary
public long pNext()
Returns:long

the value of the VkDisplayModeCreateInfoKHR#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkDisplayModeCreateInfoKHR.Buffer pNext(long value)

Sets the specified value to the VkDisplayModeCreateInfoKHR#pNext field.

selfback to summary
protected VkDisplayModeCreateInfoKHR.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDisplayModeCreateInfoKHR#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkDisplayModeCreateInfoKHR.Buffer sType(int value)

Sets the specified value to the VkDisplayModeCreateInfoKHR#sType field.

sType$Defaultback to summary
public VkDisplayModeCreateInfoKHR.Buffer sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR value to the VkDisplayModeCreateInfoKHR#sType field.