Zernikalos/zernikalos.components.mesh/ZBufferKey

ZBufferKey

@Serializable(with = ZBufferKeySerializer::class)

class ZBufferKey : ZDataRenderComponent<ZBufferKeyData, ZBufferKeyRenderer> , ZBindeable(source)

Constructors

constructor()

Initializes a new instance of ZBufferKey class. It is used to instantiate a ZBufferKey object with default data values.

constructor(id: Int, dataType: ZDataType, name: String, size: Int, count: Int, normalized: Boolean, offset: Int, stride: Int, isIndexBuffer: Boolean, bufferId: Int)

Initializes a ZBufferKey object with the given arguments.

Properties

bufferId

var bufferId: Int

Represents the buffer ID associated with the ZBufferKey.

count

var count: Int

How many elements of this type are stored. Example: If we store 15 Vec3 elements in the data array the count will have a value of 15.

data

override val data: ZBufferKeyData

Provides access to the component's serializable data.

dataType

var dataType: ZDataType

Type of data stored

var id: Int

ID for this Buffer Key.

isIndexBuffer

var isIndexBuffer: Boolean

isInitialized

override val isInitialized: Boolean

Represents a boolean value indicating whether a component has been initialized.

isRenderizable

override val isRenderizable: Boolean

Represents a boolean value indicating whether a component is renderizable.

name

var name: String

normalized

var normalized: Boolean

offset

var offset: Int

refId

override val refId: String

Represents the unique identifier for a reference-based component. The refId is used as a distinctive key for retrieving or linking this component within reference-dependent systems.

renderer

override val renderer: ZBufferKeyRenderer

Provides access to the component's renderer.

size

var size: Int

How many elements are stored per data unit. Example: a Vec3 will have size equals to 3 in the same way a Scalar will be 1

stride

var stride: Int

If the data is tightly represented within the array how many elements it requires to be jumped to the next one Example: We store a Vec3 postion and a Vec3 normal in the very same array, the stride will be 6

Functions

bind

open override fun bind()

Binds the renderer. This method is called to prepare the renderer for drawing.

dispose

override fun dispose()

Disposes the component and releases resources. Idempotent: multiple calls are safe. Subclasses with own state to release should override internalDispose.

initialize

open override fun initialize(ctx: ZRenderingContext)

Initializes the ZComponent using the provided ZRenderingContext.

toString

open override fun toString(): String

unbind

open override fun unbind()

Unbinds the renderer. This method is called after drawing to clean up.