Skip to content

@tmrw-realityos/charm / Exports / ROSGrid

Class: ROSGrid

An element that adds functionality to ROSPlayer and lives inside the host, usually a <ros-player> element. Defines a simplified and isolated way to communicate with the host without knowing its inner details.

Hierarchy

  • LitElement

    ROSGrid

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ROSGrid(): ROSGrid

Returns

ROSGrid

Inherited from

LitElement.constructor

Defined in

node_modules/.pnpm/@lit+reactive-element@2.0.4/node_modules/@lit/reactive-element/development/reactive-element.d.ts:504

Properties

color

color: RGBAColor

Defined in

packages/charm/src/webComponents/ROSGrid.ts:29

Methods

connectedCallback

connectedCallback(): void

Returns

void

Overrides

LitElement.connectedCallback

Defined in

packages/charm/src/webComponents/ROSGrid.ts:41


createPipelines

createPipelines(device, colorFormat): void

Parameters

NameType
deviceGPUDevice
colorFormatundefined | GPUTextureFormat

Returns

void

Defined in

packages/charm/src/webComponents/ROSGrid.ts:125


disconnectedCallback

disconnectedCallback(): void

Returns

void

Overrides

LitElement.disconnectedCallback

Defined in

packages/charm/src/webComponents/ROSGrid.ts:64


initializePlugin

initializePlugin(host, device): Promise<void>

Parameters

NameType
hostROSHost
deviceGPUDevice

Returns

Promise<void>

Implementation of

ROSPlugin.initializePlugin

Defined in

packages/charm/src/webComponents/ROSGrid.ts:31


renderGrid

renderGrid(renderer, renderPass, uniformBuffer): void

Parameters

NameType
rendererWebGPURenderer
renderPassGPURenderPassEncoder
uniformBufferWebGPUBuffer

Returns

void

Defined in

packages/charm/src/webComponents/ROSGrid.ts:69


startRenderingGrid

startRenderingGrid(): Promise<void>

Returns

Promise<void>

Defined in

packages/charm/src/webComponents/ROSGrid.ts:46