Package org.lwjgl.vulkan

Class VkSwapchainDisplayNativeHdrCreateInfoAMD

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSwapchainDisplayNativeHdrCreateInfoAMD>

org.lwjgl.vulkan.VkSwapchainDisplayNativeHdrCreateInfoAMD

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSwapchainDisplayNativeHdrCreateInfoAMD
extends Struct<VkSwapchainDisplayNativeHdrCreateInfoAMD>
implements NativeResource

Structure specifying display native HDR parameters of a newly created swapchain object.

Description

If the pNext chain of VkSwapchainCreateInfoKHR does not include this structure, the default value for localDimmingEnable is TRUE, meaning local dimming is initially enabled for the swapchain.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD

Valid Usage

• It is only valid to set localDimmingEnable to TRUE if VkDisplayNativeHdrSurfaceCapabilitiesAMD::localDimmingSupport is supported

Layout

 struct VkSwapchainDisplayNativeHdrCreateInfoAMD {
     VkStructureType sType();
     void const * pNext();
     VkBool32 localDimmingEnable();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	An array of VkSwapchainDisplayNativeHdrCreateInfoAMD 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	LOCALDIMMINGENABLE	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
VkSwapchainDisplayNativeHdrCreateInfoAMD(ByteBuffer container)	Creates a VkSwapchainDisplayNativeHdrCreateInfoAMD instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSwapchainDisplayNativeHdrCreateInfoAMD	calloc()	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with memCalloc.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	calloc(int capacity)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with memCalloc.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	calloc(MemoryStack stack)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	callocStack()	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	callocStack(int capacity)	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	callocStack(MemoryStack stack)	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	create()	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with BufferUtils.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	create(int capacity)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with BufferUtils.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	create(long address)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance for the specified memory address.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	create(long address, int capacity)	Create a VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance at the specified memory.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	createSafe(long address)	Like create, but returns null if address is NULL.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
boolean	localDimmingEnable()	specifies whether local dimming is enabled for the swapchain.
VkSwapchainDisplayNativeHdrCreateInfoAMD	localDimmingEnable(boolean value)	Sets the specified value to the localDimmingEnable() field.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	malloc()	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with memAlloc.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	malloc(int capacity)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with memAlloc.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated on the specified MemoryStack.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	malloc(MemoryStack stack)	Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated on the specified MemoryStack.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	mallocStack()	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	mallocStack(int capacity)	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSwapchainDisplayNativeHdrCreateInfoAMD	mallocStack(MemoryStack stack)	Deprecated.
static int	nlocalDimmingEnable(long struct)	Unsafe version of localDimmingEnable().
static void	nlocalDimmingEnable(long struct, int value)	Unsafe version of localDimmingEnable.
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSwapchainDisplayNativeHdrCreateInfoAMD	pNext(long value)	Sets the specified value to the pNext() field.
VkSwapchainDisplayNativeHdrCreateInfoAMD	set(int sType, long pNext, boolean localDimmingEnable)	Initializes this struct with the specified values.
VkSwapchainDisplayNativeHdrCreateInfoAMD	set(VkSwapchainDisplayNativeHdrCreateInfoAMD src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkSwapchainDisplayNativeHdrCreateInfoAMD	sType(int value)	Sets the specified value to the sType() field.
VkSwapchainDisplayNativeHdrCreateInfoAMD	sType$Default()	Sets the STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

LOCALDIMMINGENABLE

public static final int LOCALDIMMINGENABLE

The struct member offsets.

Constructor Details

VkSwapchainDisplayNativeHdrCreateInfoAMD

public VkSwapchainDisplayNativeHdrCreateInfoAMD(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

localDimmingEnable

public boolean localDimmingEnable()

specifies whether local dimming is enabled for the swapchain.

sType

public VkSwapchainDisplayNativeHdrCreateInfoAMD sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSwapchainDisplayNativeHdrCreateInfoAMD sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD value to the sType() field.

pNext

public VkSwapchainDisplayNativeHdrCreateInfoAMD pNext(long value)

Sets the specified value to the pNext() field.

localDimmingEnable

public VkSwapchainDisplayNativeHdrCreateInfoAMD localDimmingEnable(boolean value)

Sets the specified value to the localDimmingEnable() field.

set

public VkSwapchainDisplayNativeHdrCreateInfoAMD set(int sType,
 long pNext,
 boolean localDimmingEnable)

Initializes this struct with the specified values.

set

public VkSwapchainDisplayNativeHdrCreateInfoAMD set(VkSwapchainDisplayNativeHdrCreateInfoAMD src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD malloc()

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

calloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD calloc()

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

create

public static VkSwapchainDisplayNativeHdrCreateInfoAMD create()

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with BufferUtils.

create

public static VkSwapchainDisplayNativeHdrCreateInfoAMD create(long address)

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance for the specified memory address.

createSafe

@Nullable
public static VkSwapchainDisplayNativeHdrCreateInfoAMD createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer create(int capacity)

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSwapchainDisplayNativeHdrCreateInfoAMD mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSwapchainDisplayNativeHdrCreateInfoAMD callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSwapchainDisplayNativeHdrCreateInfoAMD mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSwapchainDisplayNativeHdrCreateInfoAMD callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD malloc(MemoryStack stack)

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer calloc(int capacity,
 MemoryStack stack)

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

nlocalDimmingEnable

public static int nlocalDimmingEnable(long struct)

Unsafe version of localDimmingEnable().

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.

nlocalDimmingEnable

public static void nlocalDimmingEnable(long struct,
 int value)

Unsafe version of localDimmingEnable.