You.i Engine
IYIRenderer::Command Struct Reference

#include <renderer/YiRenderer.h>

Classes

union  Data
 

Public Types

enum  Type {
  Type::NodeDraw = 1,
  Type::NodePushClipping,
  Type::NodePopClipping,
  Type::NodePushTarget,
  Type::NodePopTarget,
  Type::NodePushBlending,
  Type::NodePopBlending,
  Type::NodePushMasking,
  Type::NodePopMasking,
  Type::NodePushEffectFBO,
  Type::NodePopEffectFBO,
  Type::NodeApplyEffects,
  Type::NodePushTargetNoClear,
  Type::PushCurrentCamera,
  Type::NodeReplaceCamera,
  Type::NodeApplyCamera,
  Type::PopCamera,
  Type::ClearTarget,
  Type::RecalculateClipping,
  Type::CustomFunction
}
 
using CommandFunction = std::function< void()>
 

Public Attributes

Type m_type
 
Data m_data
 

Member Typedef Documentation

◆ CommandFunction

using IYIRenderer::Command::CommandFunction = std::function<void()>

Member Enumeration Documentation

◆ Type

Enumerator
NodeDraw 
NodePushClipping 

Push : Apply clipping for the node.

NodePopClipping 

Pop : Restore to the previous clipping state prior to pushing the clipping.

NodePushTarget 

Push : Apply the render target of the node, everything until the matching pop will be drawn into this render target.

NodePopTarget 

Pop : Restore the previous render target.

NodePushBlending 

Push : Apply the blending rules for the subsequent draw operations. These rules will apply until the matching pop.

NodePopBlending 

Pop : Restore the previous blending rules.

NodePushMasking 

Push : Apply a mask, this mask will apply to everything drawn after this instruction until the matching pop.

NodePopMasking 

Pop : Remove the mask.

NodePushEffectFBO 

Push : Apply an effect framebuffer, everything following this will render into that framebuffer until the matching pop.

NodePopEffectFBO 

Pop : Restore the previous framebuffer.

NodeApplyEffects 

Render the effects defined by the attached node.

NodePushTargetNoClear 

Push : Apply the render target of the node but do not clear it.

PushCurrentCamera 

Push : Save the current camera, this render action takes no node.

NodeReplaceCamera 

Replace with this camera, use YI_PUSH_CURRENT_CAMERA and YI_POP_CAMERA if the previous state should be saved.

NodeApplyCamera 

Apply a new camera, this will concatenate on to the current camera, use YI_PUSH_CURRENT_CAMERA and YI_POP_CAMERA if the previous state should be saved.

PopCamera 

Pop : Restore the previous camera.

ClearTarget 

Clears the current rendertarget.

RecalculateClipping 

Recalculates clipping using the current camera.

CustomFunction 

Executes arbitrary code by calling the provided function.

Member Data Documentation

◆ m_data

Data IYIRenderer::Command::m_data

◆ m_type

Type IYIRenderer::Command::m_type

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