Emergency 2017 Dokumentation  v3.0.1
qsf::Renderer Namespace Reference

Own renderer related definitions. More...

Classes

struct  DescriptorRange
 
struct  DescriptorRangeBuilder
 
struct  RootConstants
 
struct  RootConstantsBuilder
 
struct  RootDescriptor
 
struct  RootDescriptorBuilder
 
struct  RootDescriptorTable
 
struct  RootDescriptorTableBuilder
 
struct  RootParameter
 
struct  RootParameterBuilder
 
struct  RootSignature
 
struct  RootSignatureBuilder
 
struct  RootSignatureFlags
 
struct  StaticSampler
 

Enumerations

enum  FillMode { FillMode::WIREFRAME = 2, FillMode::SOLID = 3 }
 
enum  CullMode { CullMode::NONE = 1, CullMode::FRONT = 2, CullMode::BACK = 3 }
 
enum  ConservativeRasterizationMode { ConservativeRasterizationMode::OFF = 0, ConservativeRasterizationMode::ON = 1 }
 
enum  DepthWriteMask { ZERO = 0, ALL = 1 }
 
enum  StencilOp {
  StencilOp::KEEP = 1, ZERO = 2, StencilOp::REPLACE = 3, StencilOp::INCR_SAT = 4,
  StencilOp::DECR_SAT = 5, StencilOp::INVERT = 6, StencilOp::INCREASE = 7, StencilOp::DECREASE = 8
}
 
enum  ComparisonFunc {
  ComparisonFunc::NEVER = 1, ComparisonFunc::LESS = 2, ComparisonFunc::EQUAL = 3, ComparisonFunc::LESS_EQUAL = 4,
  ComparisonFunc::GREATER = 5, ComparisonFunc::NOT_EQUAL = 6, ComparisonFunc::GREATER_EQUAL = 7, ComparisonFunc::ALWAYS = 8
}
 
enum  RenderTargetWriteMask {
  ZERO = 0, ZERO = 0, ZERO = 2, RED = 1,
  GREEN = 2, BLUE = 4, ALPHA = 8, ALL = RED | GREEN | BLUE | ALPHA,
  ALL = 1
}
 
enum  Blend {
  Blend::ZERO = 1, Blend::ONE = 2, Blend::SRC_COLOR = 3, Blend::INV_SRC_COLOR = 4,
  Blend::SRC_ALPHA = 5, Blend::INV_SRC_ALPHA = 6, Blend::DEST_ALPHA = 7, Blend::INV_DEST_ALPHA = 8,
  Blend::DEST_COLOR = 9, Blend::INV_DEST_COLOR = 10, Blend::SRC_ALPHA_SAT = 11, Blend::BLEND_FACTOR = 14,
  Blend::INV_BLEND_FACTOR = 15, Blend::SRC_1_COLOR = 16, Blend::INV_SRC_1_COLOR = 17, Blend::SRC_1_ALPHA = 18,
  Blend::INV_SRC_1_ALPHA = 19
}
 
enum  BlendOp {
  BlendOp::ADD = 1, BlendOp::SUBTRACT = 2, BlendOp::REV_SUBTRACT = 3, BlendOp::MIN = 4,
  BlendOp::MAX = 5
}
 
enum  DescriptorRangeType { DescriptorRangeType::SRV = 0, DescriptorRangeType::UAV = SRV + 1, DescriptorRangeType::CBV = UAV + 1, DescriptorRangeType::SAMPLER = CBV + 1 }
 
enum  RootParameterType {
  RootParameterType::DESCRIPTOR_TABLE = 0, RootParameterType::CONSTANTS_32BIT = DESCRIPTOR_TABLE + 1, RootParameterType::CBV = CONSTANTS_32BIT + 1, RootParameterType::SRV = CBV + 1,
  RootParameterType::UAV = SRV + 1
}
 
enum  ShaderVisibility {
  ShaderVisibility::ALL = 0, ShaderVisibility::VERTEX = 1, ShaderVisibility::HULL = 2, ShaderVisibility::DOMAIN = 3,
  ShaderVisibility::GEOMETRY = 4, ShaderVisibility::PIXEL = 5
}
 
enum  StaticBorderColor { StaticBorderColor::TRANSPARENT_BLACK = 0, StaticBorderColor::OPAQUE_BLACK = TRANSPARENT_BLACK + 1, StaticBorderColor::OPAQUE_WHITE = OPAQUE_BLACK + 1 }
 
enum  FilterMode {
  FilterMode::DEFAULT = -1, FilterMode::MIN_MAG_MIP_POINT = 0, FilterMode::MIN_MAG_POINT_MIP_LINEAR = 0x1, FilterMode::MIN_POINT_MAG_LINEAR_MIP_POINT = 0x4,
  FilterMode::MIN_POINT_MAG_MIP_LINEAR = 0x5, FilterMode::MIN_LINEAR_MAG_MIP_POINT = 0x10, FilterMode::MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x11, FilterMode::MIN_MAG_LINEAR_MIP_POINT = 0x14,
  FilterMode::MIN_MAG_MIP_LINEAR = 0x15, FilterMode::ANISOTROPIC = 0x55, FilterMode::COMPARISON_MIN_MAG_MIP_POINT = 0x80, FilterMode::COMPARISON_MIN_MAG_POINT_MIP_LINEAR = 0x81,
  FilterMode::COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT = 0x84, FilterMode::COMPARISON_MIN_POINT_MAG_MIP_LINEAR = 0x85, FilterMode::COMPARISON_MIN_LINEAR_MAG_MIP_POINT = 0x90, FilterMode::COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR = 0x91,
  FilterMode::COMPARISON_MIN_MAG_LINEAR_MIP_POINT = 0x94, FilterMode::COMPARISON_MIN_MAG_MIP_LINEAR = 0x95, FilterMode::COMPARISON_ANISOTROPIC = 0xd5
}
 
enum  TextureAddressMode {
  TextureAddressMode::WRAP = 1, TextureAddressMode::MIRROR = 2, TextureAddressMode::CLAMP = 3, TextureAddressMode::BORDER = 4,
  TextureAddressMode::MIRROR_ONCE = 5
}
 

Detailed Description

Own renderer related definitions.

Own renderer related definitions since OGRE doesn't have a root signature.

Remarks
Sadly, there's some naming chaos inside OGRE. Example for such an OGRE naming issue: "Ogre::HlmsMacroblock::mCullMode" with type "Ogre::CullingMode". Such naming is confusing and introduces name mismatch problems which could be avoided if it's always written exactly in the same way. Should be "Ogre::HlmsMacroblock::mCullingMode" to have a consistent naming. In order to fight such naming chaos we just stick to the Direct3D 12 terminology by introducing own definitions (we need to be Direct3D 12, Vulkan etc. ready anyway).

Enumeration Type Documentation

enum qsf::Renderer::Blend
strong
Enumerator
ZERO 
ONE 
SRC_COLOR 
INV_SRC_COLOR 
SRC_ALPHA 
INV_SRC_ALPHA 
DEST_ALPHA 
INV_DEST_ALPHA 
DEST_COLOR 
INV_DEST_COLOR 
SRC_ALPHA_SAT 
BLEND_FACTOR 
INV_BLEND_FACTOR 
SRC_1_COLOR 
INV_SRC_1_COLOR 
SRC_1_ALPHA 
INV_SRC_1_ALPHA 

Definition at line 97 of file PipelineStateTypes.h.

Enumerator
ADD 
SUBTRACT 
REV_SUBTRACT 
MIN 
MAX 

Definition at line 117 of file PipelineStateTypes.h.

Enumerator
NEVER 
LESS 
EQUAL 
LESS_EQUAL 
GREATER 
NOT_EQUAL 
GREATER_EQUAL 
ALWAYS 

Definition at line 75 of file PipelineStateTypes.h.

Enumerator
OFF 
ON 

Definition at line 50 of file PipelineStateTypes.h.

Enumerator
NONE 
FRONT 
BACK 

Definition at line 44 of file PipelineStateTypes.h.

Enumerator
ZERO 
ALL 

Definition at line 57 of file PipelineStateTypes.h.

Enumerator
SRV 
UAV 
CBV 
SAMPLER 

Definition at line 36 of file RootSignatureTypes.h.

Enumerator
WIREFRAME 
SOLID 

Definition at line 39 of file PipelineStateTypes.h.

Enumerator
DEFAULT 
MIN_MAG_MIP_POINT 
MIN_MAG_POINT_MIP_LINEAR 
MIN_POINT_MAG_LINEAR_MIP_POINT 
MIN_POINT_MAG_MIP_LINEAR 
MIN_LINEAR_MAG_MIP_POINT 
MIN_LINEAR_MAG_POINT_MIP_LINEAR 
MIN_MAG_LINEAR_MIP_POINT 
MIN_MAG_MIP_LINEAR 
ANISOTROPIC 
COMPARISON_MIN_MAG_MIP_POINT 
COMPARISON_MIN_MAG_POINT_MIP_LINEAR 
COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT 
COMPARISON_MIN_POINT_MAG_MIP_LINEAR 
COMPARISON_MIN_LINEAR_MAG_MIP_POINT 
COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR 
COMPARISON_MIN_MAG_LINEAR_MIP_POINT 
COMPARISON_MIN_MAG_MIP_LINEAR 
COMPARISON_ANISOTROPIC 

Definition at line 39 of file SamplerStateTypes.h.

Enumerator
ZERO 
ZERO 
ZERO 
RED 
GREEN 
BLUE 
ALPHA 
ALL 
ALL 

Definition at line 88 of file PipelineStateTypes.h.

Enumerator
DESCRIPTOR_TABLE 
CONSTANTS_32BIT 
CBV 
SRV 
UAV 

Definition at line 146 of file RootSignatureTypes.h.

Enumerator
ALL 
VERTEX 
HULL 
DOMAIN 
GEOMETRY 
PIXEL 

Definition at line 224 of file RootSignatureTypes.h.

Enumerator
TRANSPARENT_BLACK 
OPAQUE_BLACK 
OPAQUE_WHITE 

Definition at line 354 of file RootSignatureTypes.h.

Enumerator
KEEP 
ZERO 
REPLACE 
INCR_SAT 
DECR_SAT 
INVERT 
INCREASE 
DECREASE 

Definition at line 62 of file PipelineStateTypes.h.

Enumerator
WRAP 
MIRROR 
CLAMP 
BORDER 
MIRROR_ONCE 

Definition at line 61 of file SamplerStateTypes.h.