render:foreground
List of: Scheme Extensions
Subjects: Backgrounds and Foregrounds, Rendering Control
Contents: Rendering Base

Action: Gets the current foreground.

Filename: rbase/rnd_scm/frgd_scm.cxx

APIs: api_rh_get_foreground

Syntax: (render:foreground)

Arg Types: None

Returns: foreground

Description: This extension returns the current foreground. foreground is an entity that specifies a foreground shader. These shaders filter and transform the color of a model's pixels. The available foreground types established through the Scheme extension foreground:set-prop are "none", "depth cue", "fog".

Example: ; render:foreground

; Get a list of valid foreground types.

(foreground:types)

;; ("fog" "depth cue" "none")

; Create a "none" foreground.

(define fore1 (foreground "none"))

;; fore1

; Set the foreground.

(render:set-foreground fore1)

;; ()

; Get the current foreground.

(render:foreground)

;; #[entity 2 1]
PDF/RBASE/03SCM.PDF
HTM/DATA/RBASE/RBASE/03SCM/0035.HTM