Package org.lwjgl.vulkan

Class VkPhysicalDeviceOpacityMicromapFeaturesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceOpacityMicromapFeaturesEXT>

org.lwjgl.vulkan.VkPhysicalDeviceOpacityMicromapFeaturesEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPhysicalDeviceOpacityMicromapFeaturesEXT
extends org.lwjgl.system.Struct<VkPhysicalDeviceOpacityMicromapFeaturesEXT>
implements org.lwjgl.system.NativeResource

Structure describing the ray tracing opacity micromap features that can be supported by an implementation.

Description

If the VkPhysicalDeviceOpacityMicromapFeaturesEXT structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceOpacityMicromapFeaturesEXT can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_OPACITY_MICROMAP_FEATURES_EXT

Layout

 struct VkPhysicalDeviceOpacityMicromapFeaturesEXT {
     VkStructureType sType();
     void * pNext();
     VkBool32 micromap();
     VkBool32 micromapCaptureReplay();
     VkBool32 micromapHostCommands();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MICROMAP	The struct member offsets.
static final int	MICROMAPCAPTUREREPLAY	The struct member offsets.
static final int	MICROMAPHOSTCOMMANDS	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
VkPhysicalDeviceOpacityMicromapFeaturesEXT(ByteBuffer container)	Creates a VkPhysicalDeviceOpacityMicromapFeaturesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceOpacityMicromapFeaturesEXT	calloc()	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated with memCalloc.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT	create()	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated with BufferUtils.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT	create(long address)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance for the specified memory address.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceOpacityMicromapFeaturesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT	malloc()	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated with memAlloc.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceOpacityMicromapFeaturesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated on the specified MemoryStack.
boolean	micromap()	indicates whether the implementation supports the micromap array feature.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	micromap(boolean value)	Sets the specified value to the micromap() field.
boolean	micromapCaptureReplay()	indicates whether the implementation supports capture and replay of addresses for micromap arrays.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	micromapCaptureReplay(boolean value)	Sets the specified value to the micromapCaptureReplay() field.
boolean	micromapHostCommands()	indicates whether the implementation supports host side micromap array commands.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	micromapHostCommands(boolean value)	Sets the specified value to the micromapHostCommands() field.
static int	nmicromap(long struct)	Unsafe version of micromap().
static void	nmicromap(long struct, int value)	Unsafe version of micromap.
static int	nmicromapCaptureReplay(long struct)	Unsafe version of micromapCaptureReplay().
static void	nmicromapCaptureReplay(long struct, int value)	Unsafe version of micromapCaptureReplay.
static int	nmicromapHostCommands(long struct)	Unsafe version of micromapHostCommands().
static void	nmicromapHostCommands(long struct, int value)	Unsafe version of micromapHostCommands.
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.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	set(int sType, long pNext, boolean micromap, boolean micromapCaptureReplay, boolean micromapHostCommands)	Initializes this struct with the specified values.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	set(VkPhysicalDeviceOpacityMicromapFeaturesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceOpacityMicromapFeaturesEXT	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_OPACITY_MICROMAP_FEATURES_EXT value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

MICROMAP

public static final int MICROMAP

The struct member offsets.

MICROMAPCAPTUREREPLAY

public static final int MICROMAPCAPTUREREPLAY

The struct member offsets.

MICROMAPHOSTCOMMANDS

public static final int MICROMAPHOSTCOMMANDS

The struct member offsets.

Constructor Details

VkPhysicalDeviceOpacityMicromapFeaturesEXT

public VkPhysicalDeviceOpacityMicromapFeaturesEXT(ByteBuffer container)

Creates a VkPhysicalDeviceOpacityMicromapFeaturesEXT 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPhysicalDeviceOpacityMicromapFeaturesEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

micromap

public boolean micromap()

indicates whether the implementation supports the micromap array feature.

micromapCaptureReplay

public boolean micromapCaptureReplay()

indicates whether the implementation supports capture and replay of addresses for micromap arrays.

micromapHostCommands

public boolean micromapHostCommands()

indicates whether the implementation supports host side micromap array commands.

sType

public VkPhysicalDeviceOpacityMicromapFeaturesEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceOpacityMicromapFeaturesEXT sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_OPACITY_MICROMAP_FEATURES_EXT value to the sType() field.

pNext

public VkPhysicalDeviceOpacityMicromapFeaturesEXT pNext(long value)

Sets the specified value to the pNext() field.

micromap

public VkPhysicalDeviceOpacityMicromapFeaturesEXT micromap(boolean value)

Sets the specified value to the micromap() field.

micromapCaptureReplay

public VkPhysicalDeviceOpacityMicromapFeaturesEXT micromapCaptureReplay(boolean value)

Sets the specified value to the micromapCaptureReplay() field.

micromapHostCommands

public VkPhysicalDeviceOpacityMicromapFeaturesEXT micromapHostCommands(boolean value)

Sets the specified value to the micromapHostCommands() field.

set

public VkPhysicalDeviceOpacityMicromapFeaturesEXT set(int sType,
 long pNext,
 boolean micromap,
 boolean micromapCaptureReplay,
 boolean micromapHostCommands)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceOpacityMicromapFeaturesEXT set(VkPhysicalDeviceOpacityMicromapFeaturesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT malloc()

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

calloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT calloc()

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

create

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT create()

Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated with BufferUtils.

create

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT create(long address)

Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceOpacityMicromapFeaturesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer create(int capacity)

Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceOpacityMicromapFeaturesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceOpacityMicromapFeaturesEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nmicromap

public static int nmicromap(long struct)

Unsafe version of micromap().

nmicromapCaptureReplay

public static int nmicromapCaptureReplay(long struct)

Unsafe version of micromapCaptureReplay().

nmicromapHostCommands

public static int nmicromapHostCommands(long struct)

Unsafe version of micromapHostCommands().

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.

nmicromap

public static void nmicromap(long struct,
 int value)

Unsafe version of micromap.

nmicromapCaptureReplay

public static void nmicromapCaptureReplay(long struct,
 int value)

Unsafe version of micromapCaptureReplay.

nmicromapHostCommands

public static void nmicromapHostCommands(long struct,
 int value)

Unsafe version of micromapHostCommands.