Class WireframeRenderBehavior

A RenderBehavior that renders a wireframe using line primitives.

Hierarchy (View Summary)

RenderBehavior
- WireframeRenderBehavior
  - LinesRenderBehavior

Index

Constructors

constructor

new WireframeRenderBehavior(
    vertexData: Float32Array,
    indexData: Uint16Array,
    color: Color,
    vertexWGSLShader: string,
    fragmentWGSLShader: string,
): WireframeRenderBehavior
Create a new WireframeRenderBehavior that renders lines.
Parameters
- vertexData: Float32Array
  The vertex data (3 floats for position).
- indexData: Uint16Array
  The index data (line indices).
- color: Color
  The RGBA color (4 floats: r, g, b, a).
- vertexWGSLShader: string
  The vertex shader in WGSL (source code in string).
- fragmentWGSLShader: string
  The fragment shader in WGSL (source code in string).
Returns WireframeRenderBehavior
Overrides RenderBehavior.constructor
- Defined in Extensions/RenderEngine/Wireframe/WireframeRenderBehavior.ts:28

Properties

`Protected`_bindGroupLayouts

_bindGroupLayouts: null | GPUBindGroupLayout[] = null

`Protected`_indexBuffer

_indexBuffer: null | GPUBuffer = null

`Protected`_indexData

_indexData: Uint16Array

`Protected`_mvpUniformBuffer

_mvpUniformBuffer: null | GPUBuffer = null

`Protected`_pipeline

_pipeline: null | GPURenderPipeline = null

`Protected`_renderEngine

_renderEngine: Renderer

`Protected`_vertexBuffer

_vertexBuffer: null | GPUBuffer = null

Accessors

color

get color(): Color
Get the color of the wireframe.

Returns Color
- Defined in Extensions/RenderEngine/Wireframe/WireframeRenderBehavior.ts:91
set color(value: Color): void
Set the color of the wireframe.
Parameters
- value: Color
Returns void
- Defined in Extensions/RenderEngine/Wireframe/WireframeRenderBehavior.ts:99

`Protected`transform

get transform(): Transform
Returns Transform
Inherited from RenderBehavior.transform
- Defined in Core/OutputBehavior.ts:36

Methods

`Protected`asyncInit

asyncInit(): Promise<void>
Protected
Called when the rendering is ready (device is available).

Returns Promise<void>
Overrides RenderBehavior.asyncInit
- Defined in Extensions/RenderEngine/Wireframe/WireframeRenderBehavior.ts:63

detach

detach(from: GameObject): void
Detach this behavior from the GameObject it is attached to.
Parameters
- from: GameObject
  The GameObject to detach this behavior from.
Returns void
Throws
Error if the behavior is not attached to the GameObject.
Inherited from RenderBehavior.detach
- Defined in Core/Behavior.ts:27

`Protected`observe

observe<T extends LogicBehavior<U>, U>(
BehaviorClass: new (...args: any[]) => T,
observer: (data: U) => void,
): void
Protected
Observe a LogicBehavior and call the observer function when the data changes.
Type Parameters
- T extends LogicBehavior<U>
- U
Parameters
- BehaviorClass: new (...args: any[]) => T
  The specific LogicBehavior class type to observe.
- observer: (data: U) => void
  The function to call when the data changes.
Returns void
Inherited from RenderBehavior.observe
- Defined in Core/OutputBehavior.ts:20

`Protected`onDisable

onDisable(): void
Returns void
Inherited from RenderBehavior.onDisable
- Defined in Extensions/RenderEngine/RenderBehavior.ts:64

`Protected`onEnable

onEnable(): void
Returns void
Inherited from RenderBehavior.onEnable
- Defined in Extensions/RenderEngine/RenderBehavior.ts:52

render

render(renderpass: GPURenderPassEncoder): void
Render the object to the screen. Pipeline and MVP uniform are set by RenderEngine.
Parameters
- renderpass: GPURenderPassEncoder
  The render pass to render to
Returns void
Overrides RenderBehavior.render
- Defined in Extensions/RenderEngine/Wireframe/WireframeRenderBehavior.ts:116

setup

setup(attachedOn: GameObject): void
Like onEnable, but should only be for internal use, so some non-abstact direct behaviors could expose attachedOn to the user.
Parameters
- attachedOn: GameObject
  The GameObject this behavior is attached to.
Returns void
Throws
Error if the behavior is already attached to a GameObject.
Inherited from RenderBehavior.setup
- Defined in Core/OutputBehavior.ts:9

`Protected`tick

tick(_deltaTime: number): void
Protected
Called every frame. Override this method to add custom behavior.
Parameters
- _deltaTime: number
  The time in seconds since the last frame.
  
  This method should not be called directly except by the GameEngineWindowComponent.
Returns void
Inherited from RenderBehavior.tick
- Defined in Core/Behavior.ts:48

Class WireframeRenderBehavior

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WireframeRenderBehavior

Properties

Protected_bindGroupLayouts

Protected_indexBuffer

Protected_indexData

Protected_mvpUniformBuffer

Protected_pipeline

Protected_renderEngine

Protected_vertexBuffer

Accessors

color

Returns Color

Parameters

Returns void

Protectedtransform

Returns Transform

Methods

ProtectedasyncInit

Returns Promise<void>

detach

Parameters

Returns void

Throws

Protectedobserve

Type Parameters

Parameters

Returns void

ProtectedonDisable

Returns void

ProtectedonEnable

Returns void

render

Parameters

Returns void

setup

Parameters

Returns void

Throws

Protectedtick

Parameters

Returns void

Settings

On This Page

`Protected`_bindGroupLayouts

`Protected`_indexBuffer

`Protected`_indexData

`Protected`_mvpUniformBuffer

`Protected`_pipeline

`Protected`_renderEngine

`Protected`_vertexBuffer

`Protected`transform

`Protected`asyncInit

`Protected`observe

`Protected`onDisable

`Protected`onEnable

`Protected`tick