Class SimpleSkybox

Namespace

OmegaEngine.Graphics.Renderables

Assembly

OmegaEngine.dll

A cubic skybox existing of 4 or 6 non-animated planes.

public sealed class SimpleSkybox : Skybox, IDisposable

Inheritance

object

EngineElement

Renderable

Skybox

SimpleSkybox

Implements

IDisposable

Inherited Members

Renderable.PreRender

Renderable.RenderCount

Renderable.Name

Renderable.ToString()

Renderable.Visible

Renderable.Wireframe

Renderable.Alpha

EngineElement.Engine

EngineElement.IsEngineSet

EngineElement.IsDisposed

EngineElement.Dispose()

Methods

FromAssetSet(Engine, string, string)

Creates a new skybox using a set of textures following a fixed naming convention.

public static SimpleSkybox FromAssetSet(Engine engine, string name, string format = "dds")

Parameters

engine Engine

The Engine providing the cache and rendering capabilities.

name string

The base name of the skybox.

format string

The file format/ending of the texture files (e.g., dds or jpg).

Returns

SimpleSkybox

Remarks

Looks for textures named Skybox/name/rt|lf|up|dn|ft|bk.format.

Exceptions

FileNotFoundException

One of the specified texture files could not be found.

IOException

There was an error reading one of the texture files.

UnauthorizedAccessException

Read access to one of the texture files is not permitted.

InvalidDataException

One of the texture files does not contain a valid texture.

FromAssets(Engine, string, string, string?, string?, string, string)

Creates a new skybox using textures by file name.

public static SimpleSkybox FromAssets(Engine engine, string rt, string lf, string? up, string? dn, string ft, string bk)

Parameters

engine Engine

The Engine providing the cache and rendering capabilities.

rt string

The ID of the "right" texture.

lf string

The ID of the "left" texture

up string

The ID of the "up" texture.

dn string

The ID of the "down" texture.

ft string

The ID of the "front" texture.

bk string

The ID of the "back" texture.

Returns

SimpleSkybox

The skybox that was created.

Exceptions

FileNotFoundException

One of the specified texture files could not be found.

IOException

There was an error reading one of the texture files.

UnauthorizedAccessException

Read access to one of the texture files is not permitted.

InvalidDataException

One of the texture files does not contain a valid texture.

OnDispose()

Hook that is called when the object needs to dispose its internal resources.

protected override void OnDispose()

OnEngineSet()

Hook that is called when Engine is set for the first time.

protected override void OnEngineSet()