nc::NcGraphics Struct Reference

Graphics module interface. More...

#include <NcGraphics.h>

Inheritance diagram for nc::NcGraphics:

Public Member Functions
virtual void	SetCamera (Camera *camera) noexcept=0
	Set the main Camera. More...
virtual auto	GetCamera () noexcept -> Camera *=0
	Get the main Camera. More...
virtual void	SetUi (ui::IUI *ui) noexcept=0
	Set a custom ui to receive draw callbacks during rendering. More...
virtual bool	IsUiHovered () const noexcept=0
	Returns if the ui is currently hovered by the mouse.
virtual auto	GetSkybox () const -> nc::asset::AssetId=0
	Gets the current skybox. More...
virtual void	SetSkybox (const std::string &path)=0
	Set the current skybox. More...
virtual void	ClearSkybox ()=0
	Clears the active skybox. More...
virtual auto	GetEnvironment () const -> const Environment &=0
	Gets the current environment properties. More...
virtual void	SetEnvironment (const Environment &environment)=0
	Set the current environment properties. More...
virtual void	ClearEnvironment ()=0
	Clears all environment data. More...
virtual auto	IsPostProcessEffectEnabled (PostProcessEffectId effectId) const -> bool=0
	Returns if a post process effect is enabled.
virtual void	SetPostProcessEffectEnabled (PostProcessEffectId effectId, bool enabled)=0
	Enabled or disable a post process effect.
virtual auto	GetPostProcessEffectProperties (PostProcessEffectId effectId, PostProcessPassFlag::type pass) const -> const PostProcessPassProperties &=0
	Get the pass properties for a post process effect.
virtual void	SetPostProcessEffectProperties (PostProcessEffectId effectId, PostProcessPassFlag::type pass, const PostProcessPassProperties &properties)=0
	Set the pass properties for a post process effect.
virtual auto	GetTextureView (TextureViewType type, uint32_t index) -> void *=0
	Get the handle to the texture view at the given index and the given type.
Public Member Functions inherited from nc::Module
	Module (size_t id=0) noexcept
	Constructor for the Module interface. More...
auto	Id () const noexcept
	Get the module's unique id.
virtual void	OnBuildTaskGraph (task::UpdateTasks &, task::RenderTasks &)
	Called on registered modules when the task graphs are constructed.
virtual void	OnBeforeSceneLoad (const Scene &)
	Called on registered modules prior to loading a new scene. More...
virtual void	OnBeforeSceneFragmentLoad ()
	Called on registered modules immediately before loading a SceneFragment file.
virtual void	OnAfterSceneFragmentLoad ()
	Called on registered modules immediately after loading a SceneFragment file.
virtual void	Clear () noexcept
	Called on registered modules prior to clearing the Registry. This includes Scene::Unload() and NcEngine::Shutdown().

Detailed Description

Graphics module interface.

Update Tasks DebugRendererNewFrame (only in dev builds) Depends On: None Component Access: WireframeRenderer ParticleEmitterUpdate Depends On: CommitStagedChanges Component Access: Read: ParticleEmitter, Transform

Render Tasks Render Depends On: None Component Access: Write: Camera, WireframeRenderer Read: StaticMesh, SkinnedMesh, DirectionalLight, PointLight, SpotLight, Transform

Member Function Documentation

ClearEnvironment()

virtual void nc::NcGraphics::ClearEnvironment ( )

pure virtual

Clears all environment data.

This is called automatically on scene changes. The main Camera is not cleared as it can be set on a persistent Entity.

ClearSkybox()

virtual void nc::NcGraphics::ClearSkybox ( )

pure virtual

Clears the active skybox.

Clears the active skybox.

GetCamera()

virtual auto nc::NcGraphics::GetCamera ( ) -> Camera *

pure virtualnoexcept

Get the main Camera.

Returns

Camera*

GetEnvironment()

virtual auto nc::NcGraphics::GetEnvironment ( ) const -> const Environment &

pure virtual

Gets the current environment properties.

Returns

A struct containing environment properties.

GetSkybox()

virtual auto nc::NcGraphics::GetSkybox ( ) const -> nc::asset::AssetId

pure virtual

Gets the current skybox.

Returns

The AssetID of the current skybox, or NullAssetID if none set.

SetCamera()

virtual void nc::NcGraphics::SetCamera ( Camera *  camera )

pure virtualnoexcept

Set the main Camera.

A valid Camera must always be registered during execution except during scene changes.

Parameters

camera

A pointer to a valid Camera.

SetEnvironment()

virtual void nc::NcGraphics::SetEnvironment ( const Environment &  environment )

pure virtual

Set the current environment properties.

Parameters

environment

Struct containing environment properties.

SetSkybox()

virtual void nc::NcGraphics::SetSkybox ( const std::string &  path )

pure virtual

Set the current skybox.

Parameters

path	A path to a skybox asset file.

SetUi()

virtual void nc::NcGraphics::SetUi ( ui::IUI *  ui )

pure virtualnoexcept

Set a custom ui to receive draw callbacks during rendering.

Parameters

ui	A pointer to a valid IUI implementation.

---

The documentation for this struct was generated from the following file:

• include/ncengine/graphics/NcGraphics.h