Documentation / @ripl/vue-3d / useRiplRenderer

Function: useRiplRenderer()

useRiplRenderer(): ShallowRef<Renderer | undefined>

Defined in: vue/src/compositions/index.ts:71

Returns the renderer provided by the nearest renderer component.

Returns

ShallowRef<Renderer | undefined>

The renderer, or undefined when no renderer component encloses the caller.

Example

const renderer = useRiplRenderer();

const pulse = (element: Element) => renderer.value?.transition(element, {
    duration: 300,
    state: { opacity: 0.5 },
});