Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDisplayPropertiesKHR

extends Struct<VkDisplayPropertiesKHR>
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 an available display device.
See Also

VkDisplayProperties2KHR, VkExtent2D, GetPhysicalDeviceDisplayPropertiesKHR

Layout


struct VkDisplayPropertiesKHR {
    VkDisplayKHR display;
    char const * displayName;
    VkExtent2D physicalDimensions;
    VkExtent2D physicalResolution;
    VkSurfaceTransformFlagsKHR supportedTransforms;
    VkBool32 planeReorderPossible;
    VkBool32 persistentContent;
}

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
DISPLAY

The struct member offsets.

public static final int
DISPLAYNAME

The struct member offsets.

public static final int
PERSISTENTCONTENT

The struct member offsets.

public static final int
PHYSICALDIMENSIONS

The struct member offsets.

public static final int
PHYSICALRESOLUTION

The struct member offsets.

public static final int
PLANEREORDERPOSSIBLE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUPPORTEDTRANSFORMS

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkDisplayPropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDisplayPropertiesKHR
calloc()

Returns a new VkDisplayPropertiesKHR instance allocated with memCalloc.

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

Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDisplayPropertiesKHR
callocStack()

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

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

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

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

Returns a new VkDisplayPropertiesKHR instance allocated with BufferUtils.

public static VkDisplayPropertiesKHR
create(long address)

Returns a new VkDisplayPropertiesKHR instance for the specified memory address.

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

Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkDisplayPropertiesKHR.Buffer instance at the specified memory.

public static VkDisplayPropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
display()

a handle that is used to refer to the display described here.

public ByteBuffer
displayName()

NULL or a pointer to a null-terminated UTF-8 string containing the name of the display.

public String
displayNameString()

NULL or a pointer to a null-terminated UTF-8 string containing the name of the display.

public static VkDisplayPropertiesKHR
malloc()

Returns a new VkDisplayPropertiesKHR instance allocated with memAlloc.

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

Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkDisplayPropertiesKHR instance allocated on the specified MemoryStack.

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

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

public static VkDisplayPropertiesKHR
mallocStack()

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

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

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

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

Unsafe version of display.

public static ByteBuffer
ndisplayName(long struct)

Unsafe version of displayName.

public static String
ndisplayNameString(long struct)

Unsafe version of displayNameString.

public static int
npersistentContent(long struct)

Unsafe version of persistentContent.

public static VkExtent2D
nphysicalDimensions(long struct)

Unsafe version of physicalDimensions.

public static VkExtent2D
nphysicalResolution(long struct)

Unsafe version of physicalResolution.

public static int
nplaneReorderPossible(long struct)

Unsafe version of planeReorderPossible.

public static int
nsupportedTransforms(long struct)

Unsafe version of supportedTransforms.

public boolean
persistentContent()

tells whether the display supports self-refresh/internal buffering.

public VkExtent2D
physicalDimensions()

describes the physical width and height of the visible portion of the display, in millimeters.

public VkExtent2D
physicalResolution()

describes the physical, native, or preferred resolution of the display.

public boolean
planeReorderPossible()

tells whether the planes on this display can have their z order changed.

public int
sizeof()

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

Returns sizeof(struct).
public int
supportedTransforms()

a bitmask of VkSurfaceTransformFlagBitsKHR describing which transforms are supported by this display.

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.

DISPLAYback to summary
public static final int DISPLAY

The struct member offsets.

DISPLAYNAMEback to summary
public static final int DISPLAYNAME

The struct member offsets.

PERSISTENTCONTENTback to summary
public static final int PERSISTENTCONTENT

The struct member offsets.

PHYSICALDIMENSIONSback to summary
public static final int PHYSICALDIMENSIONS

The struct member offsets.

PHYSICALRESOLUTIONback to summary
public static final int PHYSICALRESOLUTION

The struct member offsets.

PLANEREORDERPOSSIBLEback to summary
public static final int PLANEREORDERPOSSIBLE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUPPORTEDTRANSFORMSback to summary
public static final int SUPPORTEDTRANSFORMS

The struct member offsets.

Constructor Detail

VkDisplayPropertiesKHRback to summary
protected VkDisplayPropertiesKHR(long address, ByteBuffer container)
VkDisplayPropertiesKHRback to summary
public VkDisplayPropertiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDisplayPropertiesKHR calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkDisplayPropertiesKHR instance allocated with BufferUtils.

createback to summary
public static VkDisplayPropertiesKHR create(long address)

Returns a new VkDisplayPropertiesKHR instance for the specified memory address.

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

Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDisplayPropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDisplayPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
displayback to summary
public long display()

a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.

Annotations
@NativeType:VkDisplayKHR
displayNameback to summary
public ByteBuffer displayName()

NULL or a pointer to a null-terminated UTF-8 string containing the name of the display. Generally, this will be the name provided by the display’s EDID. If NULL, no suitable name is available. If not NULL, the string pointed to must remain accessible and unmodified as long as display is valid.

Annotations
@NativeType:char const *
displayNameStringback to summary
public String displayNameString()

NULL or a pointer to a null-terminated UTF-8 string containing the name of the display. Generally, this will be the name provided by the display’s EDID. If NULL, no suitable name is available. If not NULL, the string pointed to must remain accessible and unmodified as long as display is valid.

Annotations
@NativeType:char const *
mallocback to summary
public static VkDisplayPropertiesKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDisplayPropertiesKHR malloc(MemoryStack stack)

Returns a new VkDisplayPropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndisplayback to summary
public static long ndisplay(long struct)

Unsafe version of display.

ndisplayNameback to summary
public static ByteBuffer ndisplayName(long struct)

Unsafe version of displayName.

ndisplayNameStringback to summary
public static String ndisplayNameString(long struct)

Unsafe version of displayNameString.

npersistentContentback to summary
public static int npersistentContent(long struct)

Unsafe version of persistentContent.

nphysicalDimensionsback to summary
public static VkExtent2D nphysicalDimensions(long struct)

Unsafe version of physicalDimensions.

nphysicalResolutionback to summary
public static VkExtent2D nphysicalResolution(long struct)

Unsafe version of physicalResolution.

nplaneReorderPossibleback to summary
public static int nplaneReorderPossible(long struct)

Unsafe version of planeReorderPossible.

nsupportedTransformsback to summary
public static int nsupportedTransforms(long struct)

Unsafe version of supportedTransforms.

persistentContentback to summary
public boolean persistentContent()

tells whether the display supports self-refresh/internal buffering. If this is true, the application can submit persistent present operations on swapchains created against this display.

Note

Persistent presents may have higher latency, and may use less power when the screen content is updated infrequently, or when only a portion of the screen needs to be updated in most frames.

Annotations
@NativeType:VkBool32
physicalDimensionsback to summary
public VkExtent2D physicalDimensions()

describes the physical width and height of the visible portion of the display, in millimeters.

physicalResolutionback to summary
public VkExtent2D physicalResolution()

describes the physical, native, or preferred resolution of the display.

Note

For devices which have no natural value to return here, implementations should return the maximum resolution supported.

planeReorderPossibleback to summary
public boolean planeReorderPossible()

tells whether the planes on this display can have their z order changed. If this is TRUE, the application can re-arrange the planes on this display in any order relative to each other.

Annotations
@NativeType:VkBool32
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
supportedTransformsback to summary
public int supportedTransforms()

a bitmask of VkSurfaceTransformFlagBitsKHR describing which transforms are supported by this display.

Annotations
@NativeType:VkSurfaceTransformFlagsKHR
org.lwjgl.vulkan back to summary

public Class VkDisplayPropertiesKHR.Buffer

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

An array of VkDisplayPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkDisplayPropertiesKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDisplayPropertiesKHR.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 VkDisplayPropertiesKHR#display field.
display
()

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the VkDisplayPropertiesKHR#displayName field.
displayName
()

public String

Returns:

the null-terminated string pointed to by the VkDisplayPropertiesKHR#displayName field.
displayNameString
()

protected VkDisplayPropertiesKHR
public boolean
public VkExtent2D
public VkExtent2D
public boolean
protected VkDisplayPropertiesKHR.Buffer
public int
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDisplayPropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

displayback to summary
public long display()
Returns:long

the value of the VkDisplayPropertiesKHR#display field.

Annotations
@NativeType:VkDisplayKHR
displayNameback to summary
public ByteBuffer displayName()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the VkDisplayPropertiesKHR#displayName field.

Annotations
@NativeType:char const *
displayNameStringback to summary
public String displayNameString()
Returns:String

the null-terminated string pointed to by the VkDisplayPropertiesKHR#displayName field.

Annotations
@NativeType:char const *
getElementFactoryback to summary
protected VkDisplayPropertiesKHR getElementFactory()

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

Annotations
@Override
persistentContentback to summary
public boolean persistentContent()
Returns:boolean

the value of the VkDisplayPropertiesKHR#persistentContent field.

Annotations
@NativeType:VkBool32
physicalDimensionsback to summary
public VkExtent2D physicalDimensions()
Returns:VkExtent2D

a VkExtent2D view of the VkDisplayPropertiesKHR#physicalDimensions field.

physicalResolutionback to summary
public VkExtent2D physicalResolution()
Returns:VkExtent2D

a VkExtent2D view of the VkDisplayPropertiesKHR#physicalResolution field.

planeReorderPossibleback to summary
public boolean planeReorderPossible()
Returns:boolean

the value of the VkDisplayPropertiesKHR#planeReorderPossible field.

Annotations
@NativeType:VkBool32
selfback to summary
protected VkDisplayPropertiesKHR.Buffer self()

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

Annotations
@Override
supportedTransformsback to summary
public int supportedTransforms()
Returns:int

the value of the VkDisplayPropertiesKHR#supportedTransforms field.

Annotations
@NativeType:VkSurfaceTransformFlagsKHR