Package org.lwjgl.vulkan

Class VkDisplayPropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayPropertiesKHR>

org.lwjgl.vulkan.VkDisplayPropertiesKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDisplayPropertiesKHR
extends Struct<VkDisplayPropertiesKHR>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DISPLAY	The struct member offsets.
static final int	DISPLAYNAME	The struct member offsets.
static final int	PERSISTENTCONTENT	The struct member offsets.
static final int	PHYSICALDIMENSIONS	The struct member offsets.
static final int	PHYSICALRESOLUTION	The struct member offsets.
static final int	PLANEREORDERPOSSIBLE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SUPPORTEDTRANSFORMS	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
VkDisplayPropertiesKHR(ByteBuffer container)	Creates a VkDisplayPropertiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDisplayPropertiesKHR	calloc()	Returns a new VkDisplayPropertiesKHR instance allocated with memCalloc.
static VkDisplayPropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with memCalloc.
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.
static VkDisplayPropertiesKHR	calloc(MemoryStack stack)	Returns a new VkDisplayPropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplayPropertiesKHR	callocStack()	Deprecated.
static VkDisplayPropertiesKHR.Buffer	callocStack(int capacity)	Deprecated.
static VkDisplayPropertiesKHR.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDisplayPropertiesKHR	callocStack(MemoryStack stack)	Deprecated.
static VkDisplayPropertiesKHR	create()	Returns a new VkDisplayPropertiesKHR instance allocated with BufferUtils.
static VkDisplayPropertiesKHR.Buffer	create(int capacity)	Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with BufferUtils.
static VkDisplayPropertiesKHR	create(long address)	Returns a new VkDisplayPropertiesKHR instance for the specified memory address.
static VkDisplayPropertiesKHR.Buffer	create(long address, int capacity)	Create a VkDisplayPropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkDisplayPropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplayPropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	display()
ByteBuffer	displayName()
String	displayNameString()
static VkDisplayPropertiesKHR	malloc()	Returns a new VkDisplayPropertiesKHR instance allocated with memAlloc.
static VkDisplayPropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with memAlloc.
static VkDisplayPropertiesKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDisplayPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplayPropertiesKHR	malloc(MemoryStack stack)	Returns a new VkDisplayPropertiesKHR instance allocated on the specified MemoryStack.
static VkDisplayPropertiesKHR	mallocStack()	Deprecated.
static VkDisplayPropertiesKHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkDisplayPropertiesKHR.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDisplayPropertiesKHR	mallocStack(MemoryStack stack)	Deprecated.
static long	ndisplay(long struct)	Unsafe version of display().
static ByteBuffer	ndisplayName(long struct)	Unsafe version of displayName().
static String	ndisplayNameString(long struct)	Unsafe version of displayNameString().
static int	npersistentContent(long struct)	Unsafe version of persistentContent().
static VkExtent2D	nphysicalDimensions(long struct)	Unsafe version of physicalDimensions().
static VkExtent2D	nphysicalResolution(long struct)	Unsafe version of physicalResolution().
static int	nplaneReorderPossible(long struct)	Unsafe version of planeReorderPossible().
static int	nsupportedTransforms(long struct)	Unsafe version of supportedTransforms().
boolean	persistentContent()
VkExtent2D	physicalDimensions()
VkExtent2D	physicalResolution()
boolean	planeReorderPossible()
int	sizeof()	Returns sizeof(struct).
int	supportedTransforms()

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.

DISPLAY

public static final int DISPLAY

The struct member offsets.

DISPLAYNAME

public static final int DISPLAYNAME

The struct member offsets.

PHYSICALDIMENSIONS

public static final int PHYSICALDIMENSIONS

The struct member offsets.

PHYSICALRESOLUTION

public static final int PHYSICALRESOLUTION

The struct member offsets.

SUPPORTEDTRANSFORMS

public static final int SUPPORTEDTRANSFORMS

The struct member offsets.

PLANEREORDERPOSSIBLE

public static final int PLANEREORDERPOSSIBLE

The struct member offsets.

PERSISTENTCONTENT

public static final int PERSISTENTCONTENT

The struct member offsets.

Constructor Details

VkDisplayPropertiesKHR

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDisplayPropertiesKHR>

display

public long display()

Returns:

the value of the display field.

displayName

public ByteBuffer displayName()

Returns:

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

displayNameString

public String displayNameString()

Returns:

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

physicalDimensions

public VkExtent2D physicalDimensions()

Returns:

a VkExtent2D view of the physicalDimensions field.

physicalResolution

public VkExtent2D physicalResolution()

Returns:

a VkExtent2D view of the physicalResolution field.

supportedTransforms

public int supportedTransforms()

Returns:

the value of the supportedTransforms field.

planeReorderPossible

public boolean planeReorderPossible()

Returns:

the value of the planeReorderPossible field.

persistentContent

public boolean persistentContent()

Returns:

the value of the persistentContent field.

malloc

public static VkDisplayPropertiesKHR malloc()

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

calloc

public static VkDisplayPropertiesKHR calloc()

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

create

public static VkDisplayPropertiesKHR create()

Returns a new VkDisplayPropertiesKHR instance allocated with BufferUtils.

create

public static VkDisplayPropertiesKHR create(long address)

Returns a new VkDisplayPropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplayPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayPropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayPropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayPropertiesKHR.Buffer create(int capacity)

Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayPropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayPropertiesKHR mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayPropertiesKHR callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayPropertiesKHR mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayPropertiesKHR callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayPropertiesKHR.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayPropertiesKHR.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkDisplayPropertiesKHR malloc(MemoryStack stack)

Returns a new VkDisplayPropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

ndisplay

public static long ndisplay(long struct)

Unsafe version of display().

ndisplayName

public static ByteBuffer ndisplayName(long struct)

Unsafe version of displayName().

ndisplayNameString

public static String ndisplayNameString(long struct)

Unsafe version of displayNameString().

nphysicalDimensions

public static VkExtent2D nphysicalDimensions(long struct)

Unsafe version of physicalDimensions().

nphysicalResolution

public static VkExtent2D nphysicalResolution(long struct)

Unsafe version of physicalResolution().

nsupportedTransforms

public static int nsupportedTransforms(long struct)

Unsafe version of supportedTransforms().

nplaneReorderPossible

public static int nplaneReorderPossible(long struct)

Unsafe version of planeReorderPossible().

npersistentContent

public static int npersistentContent(long struct)

Unsafe version of persistentContent().