Set Render Setting

Toggles a target view option.

Syntax

store.dispatch({ type: "SET_VIEW_OPTION", payload: { key: viewOption, value } });

Parameters

viewOption

The name of the view option to toggle. Available view options can be found here.

value

A boolean indicating whether to enable the target view option.

Examples

Enables color playback.

store.dispatch({
  type: "SET_VIEW_OPTION",
  payload: {key: "colorPlayback", value: true }
});

Shows the viewport (as long as the camera dimensions are specified).

store.dispatch({
  type: "SET_VIEW_OPTION",
  payload: {key: "showViewport", value: true }
});