Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDisplayModePropertiesKHR

extends Struct<VkDisplayModePropertiesKHR>
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 mode properties.
See Also

VkDisplayModeParametersKHR, VkDisplayModeProperties2KHR, GetDisplayModePropertiesKHR

Layout


struct VkDisplayModePropertiesKHR {
    VkDisplayModeKHR displayMode;
    VkDisplayModeParametersKHR parameters;
}

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
DISPLAYMODE

The struct member offsets.

public static final int
PARAMETERS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkDisplayModePropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDisplayModePropertiesKHR
calloc()

Returns a new VkDisplayModePropertiesKHR instance allocated with memCalloc.

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

Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDisplayModePropertiesKHR
callocStack()

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

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

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

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

Returns a new VkDisplayModePropertiesKHR instance allocated with BufferUtils.

public static VkDisplayModePropertiesKHR
create(long address)

Returns a new VkDisplayModePropertiesKHR instance for the specified memory address.

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

Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkDisplayModePropertiesKHR.Buffer instance at the specified memory.

public static VkDisplayModePropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
displayMode()

a handle to the display mode described in this structure.

public static VkDisplayModePropertiesKHR
malloc()

Returns a new VkDisplayModePropertiesKHR instance allocated with memAlloc.

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

Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkDisplayModePropertiesKHR instance allocated on the specified MemoryStack.

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

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

public static VkDisplayModePropertiesKHR
mallocStack()

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

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

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

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

Unsafe version of displayMode.

public static VkDisplayModeParametersKHR
nparameters(long struct)

Unsafe version of parameters.

public VkDisplayModeParametersKHR
parameters()

a VkDisplayModeParametersKHR structure describing the display parameters associated with displayMode.

public int
sizeof()

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

Returns sizeof(struct).
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.

DISPLAYMODEback to summary
public static final int DISPLAYMODE

The struct member offsets.

PARAMETERSback to summary
public static final int PARAMETERS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

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

callocback to summary
public static VkDisplayModePropertiesKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDisplayModePropertiesKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkDisplayModePropertiesKHR instance allocated with BufferUtils.

createback to summary
public static VkDisplayModePropertiesKHR create(long address)

Returns a new VkDisplayModePropertiesKHR instance for the specified memory address.

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

Returns a new VkDisplayModePropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDisplayModePropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDisplayModePropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
displayModeback to summary
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.

Annotations
@NativeType:VkDisplayModeKHR
mallocback to summary
public static VkDisplayModePropertiesKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDisplayModePropertiesKHR malloc(MemoryStack stack)

Returns a new VkDisplayModePropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndisplayModeback to summary
public static long ndisplayMode(long struct)

Unsafe version of displayMode.

nparametersback to summary
public static VkDisplayModeParametersKHR nparameters(long struct)

Unsafe version of parameters.

parametersback to summary
public VkDisplayModeParametersKHR parameters()

a VkDisplayModeParametersKHR structure describing the display parameters associated with displayMode.

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
org.lwjgl.vulkan back to summary

public Class VkDisplayModePropertiesKHR.Buffer

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

An array of VkDisplayModePropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDisplayModePropertiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the VkDisplayModePropertiesKHR#displayMode field.
displayMode
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDisplayModePropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

displayModeback to summary
public long displayMode()
Returns:long

the value of the VkDisplayModePropertiesKHR#displayMode field.

Annotations
@NativeType:VkDisplayModeKHR
getElementFactoryback to summary
protected VkDisplayModePropertiesKHR getElementFactory()

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

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

a VkDisplayModeParametersKHR view of the VkDisplayModePropertiesKHR#parameters field.

selfback to summary
protected VkDisplayModePropertiesKHR.Buffer self()

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

Annotations
@Override