Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSwapchainDisplayNativeHdrCreateInfoAMD

extends Struct<VkSwapchainDisplayNativeHdrCreateInfoAMD>
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 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)
Valid Usage

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer

An array of VkSwapchainDisplayNativeHdrCreateInfoAMD structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LOCALDIMMINGENABLE

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
VkSwapchainDisplayNativeHdrCreateInfoAMD(long address, ByteBuffer container)

public
VkSwapchainDisplayNativeHdrCreateInfoAMD(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSwapchainDisplayNativeHdrCreateInfoAMD
calloc()

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with memCalloc.

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSwapchainDisplayNativeHdrCreateInfoAMD
callocStack()

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

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

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

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with BufferUtils.

public static VkSwapchainDisplayNativeHdrCreateInfoAMD
create(long address)

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance for the specified memory address.

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with BufferUtils.

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

Create a VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance at the specified memory.

public static VkSwapchainDisplayNativeHdrCreateInfoAMD
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
localDimmingEnable()

specifies whether local dimming is enabled for the swapchain.

public VkSwapchainDisplayNativeHdrCreateInfoAMD
localDimmingEnable(boolean value)

Sets the specified value to the localDimmingEnable field.

public static VkSwapchainDisplayNativeHdrCreateInfoAMD
malloc()

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with memAlloc.

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with memAlloc.

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated on the specified MemoryStack.

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

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

public static VkSwapchainDisplayNativeHdrCreateInfoAMD
mallocStack()

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

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

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

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

Unsafe version of localDimmingEnable.

public static void
nlocalDimmingEnable(long struct, int value)

Unsafe version of localDimmingEnable.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSwapchainDisplayNativeHdrCreateInfoAMD
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkSwapchainDisplayNativeHdrCreateInfoAMD

Returns:

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

Sets the specified value to the sType field.

public VkSwapchainDisplayNativeHdrCreateInfoAMD
sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD 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.

LOCALDIMMINGENABLEback to summary
public static final int LOCALDIMMINGENABLE

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

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

callocback to summary
public static VkSwapchainDisplayNativeHdrCreateInfoAMD calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSwapchainDisplayNativeHdrCreateInfoAMD callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated with BufferUtils.

createback to summary
public static VkSwapchainDisplayNativeHdrCreateInfoAMD create(long address)

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance for the specified memory address.

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

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSwapchainDisplayNativeHdrCreateInfoAMD createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
localDimmingEnableback to summary
public boolean localDimmingEnable()

specifies whether local dimming is enabled for the swapchain.

Annotations
@NativeType:VkBool32
localDimmingEnableback to summary
public VkSwapchainDisplayNativeHdrCreateInfoAMD localDimmingEnable(boolean value)

Sets the specified value to the localDimmingEnable field.

mallocback to summary
public static VkSwapchainDisplayNativeHdrCreateInfoAMD malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSwapchainDisplayNativeHdrCreateInfoAMD malloc(MemoryStack stack)

Returns a new VkSwapchainDisplayNativeHdrCreateInfoAMD instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nlocalDimmingEnableback to summary
public static int nlocalDimmingEnable(long struct)

Unsafe version of localDimmingEnable.

nlocalDimmingEnableback to summary
public static void nlocalDimmingEnable(long struct, int value)

Unsafe version of localDimmingEnable.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkSwapchainDisplayNativeHdrCreateInfoAMD set(VkSwapchainDisplayNativeHdrCreateInfoAMD src)

Copies the specified struct data to this struct.

Parameters
src:VkSwapchainDisplayNativeHdrCreateInfoAMD

the source struct

Returns:VkSwapchainDisplayNativeHdrCreateInfoAMD

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 VkSwapchainDisplayNativeHdrCreateInfoAMD sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkSwapchainDisplayNativeHdrCreateInfoAMD
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSwapchainDisplayNativeHdrCreateInfoAMD.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
protected VkSwapchainDisplayNativeHdrCreateInfoAMD
getElementFactory()

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

public boolean

Returns:

the value of the VkSwapchainDisplayNativeHdrCreateInfoAMD#localDimmingEnable field.
localDimmingEnable()

public VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer
localDimmingEnable(boolean value)

Sets the specified value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#localDimmingEnable field.

public long

Returns:

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

public VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer
pNext(long value)

Sets the specified value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#pNext field.

protected VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer
self()

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

public int

Returns:

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

public VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer
sType(int value)

Sets the specified value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#sType field.

public VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSwapchainDisplayNativeHdrCreateInfoAMD ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkSwapchainDisplayNativeHdrCreateInfoAMD getElementFactory()

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

Annotations
@Override
localDimmingEnableback to summary
public boolean localDimmingEnable()
Returns:boolean

the value of the VkSwapchainDisplayNativeHdrCreateInfoAMD#localDimmingEnable field.

Annotations
@NativeType:VkBool32
localDimmingEnableback to summary
public VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer localDimmingEnable(boolean value)

Sets the specified value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#localDimmingEnable field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkSwapchainDisplayNativeHdrCreateInfoAMD#pNext field.

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

Sets the specified value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#pNext field.

selfback to summary
protected VkSwapchainDisplayNativeHdrCreateInfoAMD.Buffer self()

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

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

the value of the VkSwapchainDisplayNativeHdrCreateInfoAMD#sType field.

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

Sets the specified value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#sType field.

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

Sets the STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD value to the VkSwapchainDisplayNativeHdrCreateInfoAMD#sType field.