Package org.lwjgl.vulkan

Class VkDisplayNativeHdrSurfaceCapabilitiesAMD

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplayNativeHdrSurfaceCapabilitiesAMD>

org.lwjgl.vulkan.VkDisplayNativeHdrSurfaceCapabilitiesAMD

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDisplayNativeHdrSurfaceCapabilitiesAMD
extends Struct<VkDisplayNativeHdrSurfaceCapabilitiesAMD>
implements NativeResource

Structure describing display native HDR specific capabilities of a surface.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD

Layout

 struct VkDisplayNativeHdrSurfaceCapabilitiesAMD {
     VkStructureType sType();
     void * pNext();
     VkBool32 localDimmingSupport();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

LOCALDIMMINGSUPPORT

public static final int LOCALDIMMINGSUPPORT

The struct member offsets.

Constructor Details

VkDisplayNativeHdrSurfaceCapabilitiesAMD

public VkDisplayNativeHdrSurfaceCapabilitiesAMD(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

localDimmingSupport

public boolean localDimmingSupport()

specifies whether the surface supports local dimming. If this is TRUE, VkSwapchainDisplayNativeHdrCreateInfoAMD can be used to explicitly enable or disable local dimming for the surface. Local dimming may also be overridden by SetLocalDimmingAMD during the lifetime of the swapchain.

sType

public VkDisplayNativeHdrSurfaceCapabilitiesAMD sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDisplayNativeHdrSurfaceCapabilitiesAMD sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD value to the sType() field.

pNext

public VkDisplayNativeHdrSurfaceCapabilitiesAMD pNext(long value)

Sets the specified value to the pNext() field.

set

public VkDisplayNativeHdrSurfaceCapabilitiesAMD set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkDisplayNativeHdrSurfaceCapabilitiesAMD set(VkDisplayNativeHdrSurfaceCapabilitiesAMD src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD malloc()

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

calloc

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD calloc()

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

create

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD create()

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated with BufferUtils.

create

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD create(long address)

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance for the specified memory address.

createSafe

@Nullable
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer create(int capacity)

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD malloc(MemoryStack stack)

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlocalDimmingSupport

public static int nlocalDimmingSupport(long struct)

Unsafe version of localDimmingSupport().

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.