You.i Engine
IYIRenderer::Command Struct Reference

#include <renderer/YiRenderer.h>

Classes

union  CommandData
 

Public Types

enum  CommandType {
  NODE_DRAW = 1,
  NODE_PUSH_CLIPPING,
  NODE_POP_CLIPPING,
  NODE_PUSH_TARGET,
  NODE_POP_TARGET,
  NODE_PUSH_BLENDING,
  NODE_POP_BLENDING,
  NODE_PUSH_MASKING,
  NODE_POP_MASKING,
  NODE_PUSH_EFFECT_FBO,
  NODE_POP_EFFECT_FBO,
  NODE_APPLY_EFFECTS,
  NODE_PUSH_TARGET_NO_CLEAR,
  PUSH_CURRENT_CAMERA,
  NODE_REPLACE_CAMERA,
  NODE_APPLY_CAMERA,
  POP_CAMERA,
  CLEAR_TARGET,
  RECALCULATE_CLIPPING,
  CUSTOM_FUNCTION
}
 
using CommandFunction = std::function< void()>
 

Public Attributes

CommandType m_type
 
CommandData m_data
 

Member Typedef Documentation

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

Member Enumeration Documentation

Enumerator
NODE_DRAW 
NODE_PUSH_CLIPPING 

Push : Apply clipping for the node.

NODE_POP_CLIPPING 

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

NODE_PUSH_TARGET 

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

NODE_POP_TARGET 

Pop : Restore the previous render target.

NODE_PUSH_BLENDING 

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

NODE_POP_BLENDING 

Pop : Restore the previous blending rules.

NODE_PUSH_MASKING 

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

NODE_POP_MASKING 

Pop : Remove the mask.

NODE_PUSH_EFFECT_FBO 

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

NODE_POP_EFFECT_FBO 

Pop : Restore the previous framebuffer.

NODE_APPLY_EFFECTS 

Render the effects defined by the attached node.

NODE_PUSH_TARGET_NO_CLEAR 

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

PUSH_CURRENT_CAMERA 

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

NODE_REPLACE_CAMERA 

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

NODE_APPLY_CAMERA 

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.

POP_CAMERA 

Pop : Restore the previous camera.

CLEAR_TARGET 

Clears the current rendertarget.

RECALCULATE_CLIPPING 

Recalculates clipping using the current camera.

CUSTOM_FUNCTION 

Executes arbitrary code by calling the provided function.

Member Data Documentation

CommandData IYIRenderer::Command::m_data
CommandType IYIRenderer::Command::m_type

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