Structure specifying the usage information used to build a micromap.

Valid Usage

If the VkMicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT then format must be OPACITY_MICROMAP_FORMAT_2_STATE_EXT or OPACITY_MICROMAP_FORMAT_4_STATE_EXT
If the VkMicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT and format is OPACITY_MICROMAP_FORMAT_2_STATE_EXT then subdivisionLevel must be less than or equal to VkPhysicalDeviceOpacityMicromapPropertiesEXT::maxOpacity2StateSubdivisionLevel
If the VkMicromapTypeEXT of the micromap is MICROMAP_TYPE_OPACITY_MICROMAP_EXT and format is OPACITY_MICROMAP_FORMAT_4_STATE_EXT then subdivisionLevel must be less than or equal to VkPhysicalDeviceOpacityMicromapPropertiesEXT::maxOpacity4StateSubdivisionLevel
If the VkMicromapTypeEXT of the micromap is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV then format must be DISPLACEMENT_MICROMAP_FORMAT_64_TRIANGLES_64_BYTES_NV, DISPLACEMENT_MICROMAP_FORMAT_256_TRIANGLES_128_BYTES_NV or DISPLACEMENT_MICROMAP_FORMAT_1024_TRIANGLES_128_BYTES_NV
If the VkMicromapTypeEXT of the micromap is MICROMAP_TYPE_DISPLACEMENT_MICROMAP_NV then subdivisionLevel must be less than or equal to VkPhysicalDeviceDisplacementMicromapPropertiesNV::maxDisplacementMicromapSubdivisionLevel

The format is interpreted based on the type of the micromap using it.

Layout


struct VkMicromapUsageEXT {
    uint32_t count;
    uint32_t subdivisionLevel;
    uint32_t format;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	VkMicromapUsageEXT.Buffer An array of `VkMicromapUsageEXT` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COUNT The struct member offsets.
public static final int	FORMAT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SUBDIVISIONLEVEL The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkMicromapUsageEXT(long address, ByteBuffer container)
public	VkMicromapUsageEXT(ByteBuffer container) Creates a `VkMicromapUsageEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkMicromapUsageEXT	calloc() Returns a new `VkMicromapUsageEXT` instance allocated with `memCalloc`.
public static VkMicromapUsageEXT.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated with `memCalloc`.
public static VkMicromapUsageEXT	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkMicromapUsageEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkMicromapUsageEXT.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public int	count() the number of triangles in the usage format defined by the `subdivisionLevel` and `format` below in the micromap
public VkMicromapUsageEXT	count(int value) Sets the specified value to the `count` field.
protected VkMicromapUsageEXT	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 VkMicromapUsageEXT	create() Returns a new `VkMicromapUsageEXT` instance allocated with `BufferUtils`.
public static VkMicromapUsageEXT	create(long address) Returns a new `VkMicromapUsageEXT` instance for the specified memory address.
public static VkMicromapUsageEXT.Buffer	create(int the buffer capacity capacity) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated with `BufferUtils`.
public static VkMicromapUsageEXT.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkMicromapUsageEXT.Buffer` instance at the specified memory.
public static VkMicromapUsageEXT	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkMicromapUsageEXT.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	format() the format of this usage format
public VkMicromapUsageEXT	format(int value) Sets the specified value to the `format` field.
public static VkMicromapUsageEXT	malloc() Returns a new `VkMicromapUsageEXT` instance allocated with `memAlloc`.
public static VkMicromapUsageEXT.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated with `memAlloc`.
public static VkMicromapUsageEXT	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkMicromapUsageEXT` instance allocated on the specified `MemoryStack`.
public static VkMicromapUsageEXT.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated on the specified `MemoryStack`.
public static int	ncount(long struct) Unsafe version of `count`.
public static void	ncount(long struct, int value) Unsafe version of `count`.
public static int	nformat(long struct) Unsafe version of `format`.
public static void	nformat(long struct, int value) Unsafe version of `format`.
public static int	nsubdivisionLevel(long struct) Unsafe version of `subdivisionLevel`.
public static void	nsubdivisionLevel(long struct, int value) Unsafe version of `subdivisionLevel`.
public VkMicromapUsageEXT	set(int count, int subdivisionLevel, int format) Initializes this struct with the specified values.
public VkMicromapUsageEXT	Returns: this struct set(VkMicromapUsageEXT 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	subdivisionLevel() the subdivision level of this usage format
public VkMicromapUsageEXT	subdivisionLevel(int value) Sets the specified value to the `subdivisionLevel` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

COUNT	back to summary
public static final int COUNT The struct member offsets.

FORMAT	back to summary
public static final int FORMAT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

SUBDIVISIONLEVEL	back to summary
public static final int SUBDIVISIONLEVEL The struct member offsets.

Constructor Detail

VkMicromapUsageEXT	back to summary
protected VkMicromapUsageEXT(long address, ByteBuffer container)

VkMicromapUsageEXT back to summary

VkMicromapUsageEXT	back to summary
public VkMicromapUsageEXT(ByteBuffer container) Creates a `VkMicromapUsageEXT` 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.

public VkMicromapUsageEXT(ByteBuffer container)

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

calloc	back to summary
public static VkMicromapUsageEXT calloc() Returns a new `VkMicromapUsageEXT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkMicromapUsageEXT.Buffer calloc(int capacity) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkMicromapUsageEXT.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkMicromapUsageEXT calloc(MemoryStack stack) Returns a new `VkMicromapUsageEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkMicromapUsageEXT calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkMicromapUsageEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkMicromapUsageEXT.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

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

Returns a new VkMicromapUsageEXT.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

count back to summary

count	back to summary
public int count() the number of triangles in the usage format defined by the `subdivisionLevel` and `format` below in the micromap Annotations @NativeType:uint32_t

public int count()

the number of triangles in the usage format defined by the subdivisionLevel and format below in the micromap

Annotations

@NativeType:uint32_t

count	back to summary
public VkMicromapUsageEXT count(int value) Sets the specified value to the `count` field.

create back to summary

create	back to summary
protected VkMicromapUsageEXT 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

protected VkMicromapUsageEXT 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

create	back to summary
public static VkMicromapUsageEXT create() Returns a new `VkMicromapUsageEXT` instance allocated with `BufferUtils`.

create	back to summary
public static VkMicromapUsageEXT create(long address) Returns a new `VkMicromapUsageEXT` instance for the specified memory address.

create back to summary

create	back to summary
public static VkMicromapUsageEXT.Buffer create(int capacity) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkMicromapUsageEXT.Buffer create(int capacity)

Returns a new VkMicromapUsageEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkMicromapUsageEXT.Buffer create(long address, int capacity) Create a `VkMicromapUsageEXT.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkMicromapUsageEXT.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkMicromapUsageEXT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkMicromapUsageEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkMicromapUsageEXT.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

format	back to summary
public int format() the format of this usage format Annotations @NativeType:uint32_t

format

back to summary

public int format()

the format of this usage format

Annotations

@NativeType:uint32_t

format	back to summary
public VkMicromapUsageEXT format(int value) Sets the specified value to the `format` field.

malloc	back to summary
public static VkMicromapUsageEXT malloc() Returns a new `VkMicromapUsageEXT` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkMicromapUsageEXT.Buffer malloc(int capacity) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkMicromapUsageEXT.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkMicromapUsageEXT malloc(MemoryStack stack) Returns a new `VkMicromapUsageEXT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkMicromapUsageEXT malloc(MemoryStack stack)

Returns a new VkMicromapUsageEXT instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkMicromapUsageEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkMicromapUsageEXT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

ncount	back to summary
public static int ncount(long struct) Unsafe version of `count`.

ncount	back to summary
public static void ncount(long struct, int value) Unsafe version of `count`.

nformat	back to summary
public static int nformat(long struct) Unsafe version of `format`.

nformat	back to summary
public static void nformat(long struct, int value) Unsafe version of `format`.

nsubdivisionLevel	back to summary
public static int nsubdivisionLevel(long struct) Unsafe version of `subdivisionLevel`.

nsubdivisionLevel	back to summary
public static void nsubdivisionLevel(long struct, int value) Unsafe version of `subdivisionLevel`.

set	back to summary
public VkMicromapUsageEXT set(int count, int subdivisionLevel, int format) Initializes this struct with the specified values.

set	back to summary
public VkMicromapUsageEXT set(VkMicromapUsageEXT src) Copies the specified struct data to this struct. Parameters src:VkMicromapUsageEXT the source struct Returns:VkMicromapUsageEXT this struct

set

back to summary

public VkMicromapUsageEXT set(VkMicromapUsageEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkMicromapUsageEXT: the source struct

Returns:VkMicromapUsageEXT

this struct

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

subdivisionLevel	back to summary
public int subdivisionLevel() the subdivision level of this usage format Annotations @NativeType:uint32_t

subdivisionLevel

back to summary

public int subdivisionLevel()

the subdivision level of this usage format

Annotations

@NativeType:uint32_t

subdivisionLevel	back to summary
public VkMicromapUsageEXT subdivisionLevel(int value) Sets the specified value to the `subdivisionLevel` field.

org.lwjgl.vulkan back to summary

public Class VkMicromapUsageEXT.Buffer

Class Inheritance

extends StructBuffer<VkMicromapUsageEXT, VkMicromapUsageEXT.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkMicromapUsageEXT.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkMicromapUsageEXT structs.

Field Summary

Modifier and Type	Field and Description
private static final VkMicromapUsageEXT	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkMicromapUsageEXT.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 Type	Method and Description
public int	Returns: the value of the `VkMicromapUsageEXT#count` field. count()
public VkMicromapUsageEXT.Buffer	count(int value) Sets the specified value to the `VkMicromapUsageEXT#count` field.
public int	Returns: the value of the `VkMicromapUsageEXT#format` field. format()
public VkMicromapUsageEXT.Buffer	format(int value) Sets the specified value to the `VkMicromapUsageEXT#format` field.
protected VkMicromapUsageEXT	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkMicromapUsageEXT.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkMicromapUsageEXT#subdivisionLevel` field. subdivisionLevel()
public VkMicromapUsageEXT.Buffer	subdivisionLevel(int value) Sets the specified value to the `VkMicromapUsageEXT#subdivisionLevel` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkMicromapUsageEXT ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkMicromapUsageEXT.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 `VkMicromapUsageEXT#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkMicromapUsageEXT.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 VkMicromapUsageEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

count	back to summary
public int count() Returns:int the value of the `VkMicromapUsageEXT#count` field. Annotations @NativeType:uint32_t

count	back to summary
public VkMicromapUsageEXT.Buffer count(int value) Sets the specified value to the `VkMicromapUsageEXT#count` field.

format	back to summary
public int format() Returns:int the value of the `VkMicromapUsageEXT#format` field. Annotations @NativeType:uint32_t

format	back to summary
public VkMicromapUsageEXT.Buffer format(int value) Sets the specified value to the `VkMicromapUsageEXT#format` field.

getElementFactory

back to summary

protected VkMicromapUsageEXT getElementFactory()

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

Annotations

@Override

self

back to summary

protected VkMicromapUsageEXT.Buffer self()

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

Annotations

@Override

subdivisionLevel	back to summary
public int subdivisionLevel() Returns:int the value of the `VkMicromapUsageEXT#subdivisionLevel` field. Annotations @NativeType:uint32_t

subdivisionLevel	back to summary
public VkMicromapUsageEXT.Buffer subdivisionLevel(int value) Sets the specified value to the `VkMicromapUsageEXT#subdivisionLevel` field.

public Class VkMicromapUsageEXT

Valid Usage

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkMicromapUsageEXT.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail