Structure specifying the micromap format and data for a triangle.

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 VkMicromapTriangleEXT {
    uint32_t dataOffset;
    uint16_t subdivisionLevel;
    uint16_t format;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DATAOFFSET 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	VkMicromapTriangleEXT(long address, ByteBuffer container)
public	VkMicromapTriangleEXT(ByteBuffer container) Creates a `VkMicromapTriangleEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

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

DATAOFFSET	back to summary
public static final int DATAOFFSET 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

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

VkMicromapTriangleEXT back to summary

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

Creates a VkMicromapTriangleEXT 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 VkMicromapTriangleEXT calloc() Returns a new `VkMicromapTriangleEXT` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

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

public static VkMicromapTriangleEXT.Buffer calloc(int capacity)

Returns a new VkMicromapTriangleEXT.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 VkMicromapTriangleEXT calloc(MemoryStack stack) Returns a new `VkMicromapTriangleEXT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkMicromapTriangleEXT calloc(MemoryStack stack)

Returns a new VkMicromapTriangleEXT 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 VkMicromapTriangleEXT.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkMicromapTriangleEXT.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 VkMicromapTriangleEXT.Buffer calloc(int capacity, MemoryStack stack)

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

create back to summary

create	back to summary
protected VkMicromapTriangleEXT 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 VkMicromapTriangleEXT 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 VkMicromapTriangleEXT create() Returns a new `VkMicromapTriangleEXT` instance allocated with `BufferUtils`.

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

create back to summary

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

public static VkMicromapTriangleEXT.Buffer create(int capacity)

Returns a new VkMicromapTriangleEXT.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkMicromapTriangleEXT.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 VkMicromapTriangleEXT createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkMicromapTriangleEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

dataOffset	back to summary
public int dataOffset() the offset in bytes of the start of the data for this triangle. This is a byte aligned value. Annotations @NativeType:uint32_t

dataOffset

back to summary

public int dataOffset()

the offset in bytes of the start of the data for this triangle. This is a byte aligned value.

Annotations

@NativeType:uint32_t

dataOffset	back to summary
public VkMicromapTriangleEXT dataOffset(int value) Sets the specified value to the `dataOffset` field.

format	back to summary
public short format() the format of this triangle Annotations @NativeType:uint16_t

format

back to summary

public short format()

the format of this triangle

Annotations

@NativeType:uint16_t

format	back to summary
public VkMicromapTriangleEXT format(short value) Sets the specified value to the `format` field.

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

malloc back to summary

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

public static VkMicromapTriangleEXT.Buffer malloc(int capacity)

Returns a new VkMicromapTriangleEXT.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 VkMicromapTriangleEXT malloc(MemoryStack stack) Returns a new `VkMicromapTriangleEXT` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkMicromapTriangleEXT malloc(MemoryStack stack)

Returns a new VkMicromapTriangleEXT 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 VkMicromapTriangleEXT.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkMicromapTriangleEXT.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

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

ndataOffset	back to summary
public static int ndataOffset(long struct) Unsafe version of `dataOffset`.

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

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

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

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

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

set	back to summary
public VkMicromapTriangleEXT set(int dataOffset, short subdivisionLevel, short format) Initializes this struct with the specified values.

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

set

back to summary

public VkMicromapTriangleEXT set(VkMicromapTriangleEXT src)

Copies the specified struct data to this struct.

Parameters

src:VkMicromapTriangleEXT: the source struct

Returns:VkMicromapTriangleEXT

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 short subdivisionLevel() the subdivision level of this triangle Annotations @NativeType:uint16_t

subdivisionLevel

back to summary

public short subdivisionLevel()

the subdivision level of this triangle

Annotations

@NativeType:uint16_t

subdivisionLevel	back to summary
public VkMicromapTriangleEXT subdivisionLevel(short value) Sets the specified value to the `subdivisionLevel` field.

org.lwjgl.vulkan back to summary

public Class VkMicromapTriangleEXT.Buffer

Class Inheritance

extends StructBuffer<VkMicromapTriangleEXT, VkMicromapTriangleEXT.Buffer>
implements NativeResource

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

All Implemented Interfaces

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

An array of VkMicromapTriangleEXT structs.

Field Summary

Modifier and Type	Field and Description
private static final VkMicromapTriangleEXT	ELEMENT_FACTORY

Constructor Summary

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

Constructor Detail

Buffer back to summary

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

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

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

format	back to summary
public short format() Returns:short the value of the `VkMicromapTriangleEXT#format` field. Annotations @NativeType:uint16_t

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

getElementFactory

back to summary

protected VkMicromapTriangleEXT getElementFactory()

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

Annotations

@Override

self

back to summary

protected VkMicromapTriangleEXT.Buffer self()

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

Annotations

@Override

subdivisionLevel	back to summary
public short subdivisionLevel() Returns:short the value of the `VkMicromapTriangleEXT#subdivisionLevel` field. Annotations @NativeType:uint16_t

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