Triton
Visual simulation library for ocean rendering.
Classes | Enumerations
Environment.h File Reference

The public interface for setting Triton's environmental parameters. More...

#include "TritonCommon.h"
#include "ResourceLoader.h"
#include "RandomNumberGenerator.h"
#include "WindFetch.h"
#include "Matrix3.h"
#include "Matrix4.h"
#include "OrientedBoundingBox.h"
#include "CoordinateSystem.h"
#include "TritonMap.h"
#include "TritonVector.h"
#include "TritonSet.h"
Include dependency graph for Environment.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Triton::BreakingWavesParameters
 Parameters to control behavior of breaking waves at shorelines, used by Environment::SetBreakingWaves(). More...
 
class  Triton::SwellDescription
 A structure containing a description of a swell in addition to local wind waves (from a distant storm perhaps.) More...
 
class  Triton::Environment
 Triton's public interface for specifying the environmental conditions and camera properties. More...
 

Enumerations

enum  Triton::Renderer { ,
  Triton::OPENGL_3_2, Triton::OPENGL_4_0, Triton::OPENGL_4_1, Triton::OPENGL_4_5,
  Triton::DIRECTX_9, Triton::DIRECT3D9_EX, Triton::DIRECTX_11, Triton::NO_RENDERER
}
 Support renderers for the Environment constructor. More...
 
enum  Triton::EnvironmentError { , Triton::NO_CONFIG_FOUND, Triton::NULL_RESOURCE_LOADER, Triton::NO_DEVICE, Triton::NO_CONTEXT }
 Error codes returned from Environment::Initialize(). More...
 

Detailed Description

The public interface for setting Triton's environmental parameters.

Enumeration Type Documentation

◆ EnvironmentError

Error codes returned from Environment::Initialize().

Enumerator
NO_CONFIG_FOUND 

Indicates the initialization succeeded.

NULL_RESOURCE_LOADER 

The Triton.config file could not be loaded, which likely means you created your ResourceLoader with an invalid path.

NO_DEVICE 

A null pointer was passed in for the ResourceLoader object.

NO_CONTEXT 

A null device was passed in, and you're using a DirectX renderer that requires one.

No GL context was active when calling this function.

◆ Renderer

Support renderers for the Environment constructor.

As newer versions of OpenGL emerge, specifying an older version in this enumeration should be fine as long as your context is backward-compatible.

Enumerator
OPENGL_3_2 

Targets devices capable of OpenGL 2.0 functionality.

OPENGL_4_0 

OpenGL 3.2, compatible with backward or non-backward-compatible contexts.

OPENGL_4_1 

OpenGL 4.0, compatible with backward or non-backward-compatible contexts.

OPENGL_4_5 

OpenGL 4.1, compatible with backward or non-backward-compatible contexts.

DIRECTX_9 

OpenGL 4.5, compatible with backward or non-backward-compatible contexts.

DIRECT3D9_EX 

DirectX9 device.

DIRECTX_11 

Direct3D9Ex device.

NO_RENDERER 

DirectX11 device.

No renderer; use for physics only.