# 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

- `bottomColor`
- `image`
- `topColor`

Methods

- `setImage`
- `setSingleColor`
- `setTopAndBottomColor`

## Accessors

`Background.``bottomColor`()

  The bottom color of the background.

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

  Return type: | Color4

`Background.``image`()

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

  Return type: | Texture

`Background.``topColor`()

  The top color of the background.

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

  Return type: | Color4

## Methods

### setImage

`Background.``setImage`(texture)

  Arguments: | texture (`Texture`) – None

  Use the given image as the background of the view

  Specify null to clear any previously specified background image.

  Return type: | void

### setSingleColor

`Background.``setSingleColor`(color)

  Arguments: | color (`Color4Like`) – None

  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.

  Return type: | void

### setTopAndBottomColor

`Background.``setTopAndBottomColor`(topColor, bottomColor)

  Arguments: | topColor (`Color4Like`) – None bottomColor (`Color4Like`) – None

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

  Return type: | void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Web or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...