_shader_type_8hpp_source.html

//

//  CeresEngine - A game development framework

//

//  Created by Rogiel Sulzbach.

//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.

//


#pragma once


#include "CeresEngine/DataTypes.hpp"

#include "CeresEngine/Macros.hpp"


#include "CeresEngine/Foundation/Flags.hpp"

#include "CeresEngine/Foundation/StructEnum.hpp"


namespace CeresEngine {


    enum class CE_SCRIPT_EXPORT() ShaderStage : UInt32 {

        Vertex = (1u << 0u),


        TesselationControl = (1u << 1u),


        TesselationEvaluation = (1u << 2u),


        Geometry = (1u << 3u),


        Fragment = (1u << 4u),


        Compute = (1u << 5u),


        Task = (1u << 6u),

        Mesh = (1u << 7u),


        RayTracingRayGeneration = (1u << 8u),

        RayTracingAnyHit = (1u << 9u),

        RayTracingClosestHit = (1u << 10u),

        RayTracingMiss = (1u << 11u),

        RayTracingIntersection = (1u << 12u),

        RayTracingCallable = (1u << 13u),

    };


    using ShaderStages = Flags<ShaderStage>;

    CE_FLAGS_OPERATORS(ShaderStage);


    struct ShaderType final : public StructEnum<ShaderType> {

        enum : UnderlyingType {

            Undefined = 0,


            Vertex = (1u << 0u),


            TesselationControl = (1u << 1u),


            TesselationEvaluation = (1u << 2u),


            Geometry = (1u << 3u),


            Fragment = (1u << 4u),


            Compute = (1u << 5u),


            Task = (1u << 6u),


            Mesh = (1u << 7u),


            RayTracingRayGeneration = (1u << 8u),


            RayTracingAnyHit = (1u << 9u),


            RayTracingClosestHit = (1u << 10u),


            RayTracingMiss = (1u << 11u),


            RayTracingIntersection = (1u << 12u),


            RayTracingCallable = (1u << 13u),

        } raw;


        static constexpr auto all = {

            ShaderType::Vertex,

            ShaderType::TesselationControl,

            ShaderType::TesselationEvaluation,

            ShaderType::Geometry,

            ShaderType::Fragment,

            ShaderType::Compute,

            ShaderType::Task,

            ShaderType::Mesh,

            ShaderType::RayTracingRayGeneration,

            ShaderType::RayTracingAnyHit,

            ShaderType::RayTracingClosestHit,

            ShaderType::RayTracingMiss,

            ShaderType::RayTracingIntersection,

            ShaderType::RayTracingCallable,

        };


        CE_STRUCT_ENUM_DECL(ShaderType)


        [[nodiscard]] ShaderStage getStageFlag() const noexcept;

    };


} // namespace CeresEngine


DataTypes.hpp

Flags.hpp

CE_FLAGS_OPERATORS
#define CE_FLAGS_OPERATORS(Enum)
Defines global operators for a Flags<Enum, Storage> implementation.
Definition Flags.hpp:216

Macros.hpp

CE_SCRIPT_EXPORT
#define CE_SCRIPT_EXPORT(...)
The CE_SCRIPT_EXPORT macro marks a class or method as exportable and available in scripting environme...
Definition Macros.hpp:247

StructEnum.hpp

CE_STRUCT_ENUM_DECL
#define CE_STRUCT_ENUM_DECL(T)
Definition StructEnum.hpp:49

CeresEngine::Mesh
A base class for all mesh implementations.
Definition Mesh.hpp:112

CeresEngine::StructEnum
Definition StructEnum.hpp:18

CeresEngine::StructEnum< ShaderType >::UnderlyingType
UInt32 UnderlyingType
Definition StructEnum.hpp:20

CeresEngine
Definition Application.hpp:19

CeresEngine::UInt32
std::uint32_t UInt32
Definition DataTypes.hpp:23

CeresEngine::ShaderStage
ShaderStage
Shader stage flags enumeration.
Definition ShaderType.hpp:23

CeresEngine::ShaderStage::RayTracingAnyHit
@ RayTracingAnyHit

CeresEngine::ShaderStage::Fragment
@ Fragment
Specifies the fragment shader stage (also "Pixel Shader").

CeresEngine::ShaderStage::RayTracingIntersection
@ RayTracingIntersection

CeresEngine::ShaderStage::RayTracingClosestHit
@ RayTracingClosestHit

CeresEngine::ShaderStage::TesselationEvaluation
@ TesselationEvaluation
Specifies the tessellation-evaluation shader stage (also "Domain         Shader").

CeresEngine::ShaderStage::TesselationControl
@ TesselationControl
Specifies the tessellation-control shader stage (also "Hull         Shader").

CeresEngine::ShaderStage::RayTracingMiss
@ RayTracingMiss

CeresEngine::ShaderStage::Compute
@ Compute
Specifies the compute shader stage.

CeresEngine::ShaderStage::RayTracingRayGeneration
@ RayTracingRayGeneration

CeresEngine::ShaderStage::Geometry
@ Geometry
Specifies the geometry shader stage.

CeresEngine::ShaderStage::Task
@ Task

CeresEngine::ShaderStage::RayTracingCallable
@ RayTracingCallable

CeresEngine::hash
constexpr size_t hash(const T &v)
Generates a hash for the provided type.
Definition Hash.hpp:25

CeresEngine::Flags< ShaderStage >

CeresEngine::ShaderType
Shader type enumeration.
Definition ShaderType.hpp:59

CeresEngine::ShaderType::RayTracingRayGeneration
@ RayTracingRayGeneration
Ray-tracing ray generation shader.
Definition ShaderType.hpp:89

CeresEngine::ShaderType::Undefined
@ Undefined
Undefined shader type.
Definition ShaderType.hpp:62

CeresEngine::ShaderType::TesselationEvaluation
@ TesselationEvaluation
Tessellation evaluation shader type (also "Domain Shader").
Definition ShaderType.hpp:71

CeresEngine::ShaderType::Mesh
@ Mesh
Mesh shader type.
Definition ShaderType.hpp:86

CeresEngine::ShaderType::RayTracingAnyHit
@ RayTracingAnyHit
Ray-tracing ray hit shader.
Definition ShaderType.hpp:92

CeresEngine::ShaderType::Task
@ Task
Task shader type.
Definition ShaderType.hpp:83

CeresEngine::ShaderType::Compute
@ Compute
Compute shader type.
Definition ShaderType.hpp:80

CeresEngine::ShaderType::Geometry
@ Geometry
Geometry shader type.
Definition ShaderType.hpp:74

CeresEngine::ShaderType::RayTracingClosestHit
@ RayTracingClosestHit
Ray-tracing closest ray hit shader.
Definition ShaderType.hpp:95

CeresEngine::ShaderType::TesselationControl
@ TesselationControl
Tessellation control shader type (also "Hull Shader").
Definition ShaderType.hpp:68

CeresEngine::ShaderType::RayTracingCallable
@ RayTracingCallable
Ray-tracing callable shader.
Definition ShaderType.hpp:104

CeresEngine::ShaderType::Fragment
@ Fragment
Fragment shader type (also "Pixel Shader").
Definition ShaderType.hpp:77

CeresEngine::ShaderType::Vertex
@ Vertex
Vertex shader type.
Definition ShaderType.hpp:65

CeresEngine::ShaderType::RayTracingIntersection
@ RayTracingIntersection
Ray-tracing ray intersection shader.
Definition ShaderType.hpp:101

CeresEngine::ShaderType::RayTracingMiss
@ RayTracingMiss
Ray-tracing ray miss shader.
Definition ShaderType.hpp:98

CeresEngine::ShaderType::raw
enum CeresEngine::ShaderType::@25 raw

CeresEngine::ShaderType::all
static constexpr auto all
Definition ShaderType.hpp:107

CeresEngine::ShaderType::getStageFlag
ShaderStage getStageFlag() const noexcept

CeresEngine::Vertex
A basic vertex type.
Definition Mesh.hpp:51