Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDisplayNativeHdrSurfaceCapabilitiesAMD

extends Struct<VkDisplayNativeHdrSurfaceCapabilitiesAMD>
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 display native HDR specific capabilities of a surface.
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer

An array of VkDisplayNativeHdrSurfaceCapabilitiesAMD structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LOCALDIMMINGSUPPORT

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

public
VkDisplayNativeHdrSurfaceCapabilitiesAMD(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD
calloc()

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated with memCalloc.

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD
callocStack()

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

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

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

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated with BufferUtils.

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD
create(long address)

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance for the specified memory address.

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance allocated with BufferUtils.

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

Create a VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance at the specified memory.

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
localDimmingSupport()

specifies whether the surface supports local dimming.

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD
malloc()

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated with memAlloc.

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance allocated with memAlloc.

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated on the specified MemoryStack.

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

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

public static VkDisplayNativeHdrSurfaceCapabilitiesAMD
mallocStack()

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

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

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

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

Unsafe version of localDimmingSupport.

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

Sets the specified value to the pNext field.

public VkDisplayNativeHdrSurfaceCapabilitiesAMD
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkDisplayNativeHdrSurfaceCapabilitiesAMD

Returns:

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

Sets the specified value to the sType field.

public VkDisplayNativeHdrSurfaceCapabilitiesAMD
sType$Default()

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

LOCALDIMMINGSUPPORTback to summary
public static final int LOCALDIMMINGSUPPORT

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

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

callocback to summary
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

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

the stack from which to allocate

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

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated with BufferUtils.

createback to summary
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD create(long address)

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance for the specified memory address.

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

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
localDimmingSupportback to summary
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.

Annotations
@NativeType:VkBool32
mallocback to summary
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDisplayNativeHdrSurfaceCapabilitiesAMD malloc(MemoryStack stack)

Returns a new VkDisplayNativeHdrSurfaceCapabilitiesAMD instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nlocalDimmingSupportback to summary
public static int nlocalDimmingSupport(long struct)

Unsafe version of localDimmingSupport.

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 *
pNextback to summary
public VkDisplayNativeHdrSurfaceCapabilitiesAMD pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkDisplayNativeHdrSurfaceCapabilitiesAMD set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkDisplayNativeHdrSurfaceCapabilitiesAMD set(VkDisplayNativeHdrSurfaceCapabilitiesAMD src)

Copies the specified struct data to this struct.

Parameters
src:VkDisplayNativeHdrSurfaceCapabilitiesAMD

the source struct

Returns:VkDisplayNativeHdrSurfaceCapabilitiesAMD

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkDisplayNativeHdrSurfaceCapabilitiesAMD
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public boolean

Returns:

the value of the VkDisplayNativeHdrSurfaceCapabilitiesAMD#localDimmingSupport field.
localDimmingSupport()

public long

Returns:

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

public VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer
pNext(long value)

Sets the specified value to the VkDisplayNativeHdrSurfaceCapabilitiesAMD#pNext field.

protected VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer
self()

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

public int

Returns:

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

public VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer
sType(int value)

Sets the specified value to the VkDisplayNativeHdrSurfaceCapabilitiesAMD#sType field.

public VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD value to the VkDisplayNativeHdrSurfaceCapabilitiesAMD#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDisplayNativeHdrSurfaceCapabilitiesAMD ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDisplayNativeHdrSurfaceCapabilitiesAMD.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 VkDisplayNativeHdrSurfaceCapabilitiesAMD#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 VkDisplayNativeHdrSurfaceCapabilitiesAMD getElementFactory()

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

Annotations
@Override
localDimmingSupportback to summary
public boolean localDimmingSupport()
Returns:boolean

the value of the VkDisplayNativeHdrSurfaceCapabilitiesAMD#localDimmingSupport field.

Annotations
@NativeType:VkBool32
pNextback to summary
public long pNext()
Returns:long

the value of the VkDisplayNativeHdrSurfaceCapabilitiesAMD#pNext field.

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

Sets the specified value to the VkDisplayNativeHdrSurfaceCapabilitiesAMD#pNext field.

selfback to summary
protected VkDisplayNativeHdrSurfaceCapabilitiesAMD.Buffer self()

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

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

the value of the VkDisplayNativeHdrSurfaceCapabilitiesAMD#sType field.

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

Sets the specified value to the VkDisplayNativeHdrSurfaceCapabilitiesAMD#sType field.

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

Sets the STRUCTURE_TYPE_DISPLAY_NATIVE_HDR_SURFACE_CAPABILITIES_AMD value to the VkDisplayNativeHdrSurfaceCapabilitiesAMD#sType field.