Background

class cee.Background()

Background configuration

The class defines the view background settings. The background can either be single colored or be a gradient between a top and a bottom color. Image backgrounds are also supported, in which case the image will be rendered on top of the specified background color.

You can access the background object from the view with the View.background property.

Accessors

cee.Background.bottomColor()
get bottomColor(): Color4

The bottom color of the background.

If background is single color, the topColor and bottomColor properties are equal

Returns: Color4

cee.Background.image()
get image(): Texture

If image background is in use it returns the image uses as a background.

Returns: Texture

cee.Background.topColor()
get topColor(): Color4

The top color of the background.

If background is single color, the topColor and bottomColor properties are equal

Returns: Color4

Methods

cee.Background.setImage()
setImage(texture: Texture): void

Use the given image as the background of the view

Specify null to clear any previously specified background image.

Parameters

texture: Texture

Returns: void

cee.Background.setSingleColor()
setSingleColor(color: Color4Like): void

Sets the background color to the given color (single color)

The background of the view will be cleared with the given color, and no graded background will be rendered. This is the default mode.

Parameters

color: Color4Like

Returns: void

cee.Background.setTopAndBottomColor()
setTopAndBottomColor(topColor: Color4Like, bottomColor: Color4Like): void

Sets the background color to a gradient defined by a top color and a bottom color

Parameters

topColor: Color4Like

bottomColor: Color4Like

Returns: void