pygfx.objects.Background

class pygfx.objects.Background(geometry=None, material=None, render_mask='opaque', **kwargs)

Bases: WorldObject

The scene’s background.

Can be e.g. a gradient, a static image or a skybox.

Parameters:
  • geometry (Geometry) – Must be None. Exists for compliance with the generic WorldObject API.

  • material (Material) – The material to use when rendering the background.

  • kwargs (Any) – Additional kwargs are forwarded to the object’s base class.

classmethod from_color(*colors)

Create a background with a BackgroundMaterial, using 1 uniform color, 2 colors for a vertical gradient, or 4 colors (one for each corner).

Examples

Clearcoat effect

Clearcoat effect

Clearcoat effect

Clearcoat effect

Dynamic Environment Map

Dynamic Environment Map

Environment Map Effects

Environment Map Effects

Remote glTF Viewer

Remote glTF Viewer

Iridescence

Iridescence

Line plot

Line plot

Map Screen to World

Map Screen to World

Toon Rendering 2

Toon Rendering 2

Volume and Mesh Slicing 1

Volume and Mesh Slicing 1

Mesh and Volume Slicing 2

Mesh and Volume Slicing 2

Panzoom Camera

Panzoom Camera

PBR Rendering 1

PBR Rendering 1

PBR Rendering 2

PBR Rendering 2

PBR Instanced Rendering

PBR Instanced Rendering

Color Picking

Color Picking

Mesh with quads

Mesh with quads

Camera linking 1

Camera linking 1

Camera linking 2

Camera linking 2

Nested Scenes

Nested Scenes

Subplots 2

Subplots 2

Use a Skybox

Use a Skybox

Use a Skybox

Use a Skybox

Text waterfall

Text waterfall

Transparency 1

Transparency 1

Transparency 2

Transparency 2

Orbit Camera

Orbit Camera

Pytorch Integration

Pytorch Integration

Validate ruler

Validate ruler

Validate Skybox

Validate Skybox