RamsesFrameworkTypes.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_RAMSESFRAMEWORKTYPES_H
#define RAMSES_RAMSESFRAMEWORKTYPES_H
 
#include "ramses-framework-api/StronglyTypedValue.h"
#include "stdint.h"
#include <limits>
#include <string>
 
namespace ramses
{
    using status_t = uint32_t;
 
    constexpr const status_t StatusOK = 0u;
 
    struct SceneIdTag {};
 
    using sceneId_t = StronglyTypedValue<uint64_t, 0, struct SceneIdTag>;
 
    using sceneVersionTag_t = uint64_t;
 
    constexpr const sceneVersionTag_t InvalidSceneVersionTag = static_cast<sceneVersionTag_t>(-1);
 
    using displayId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct DisplayIdTag>;
 
    using displayBufferId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct DisplayBufferIdTag>;
 
    using streamBufferId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct StreamBufferIdTag>;
 
    using externalBufferId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), struct ExternalBufferIdTag>;
 
    using dataProviderId_t = StronglyTypedValue<uint32_t, 0, struct DataProviderIdTag>;
 
    using dataConsumerId_t = StronglyTypedValue<uint32_t, 0, struct DataConsumerIdTag>;
 
    struct resourceId_t
    {
        constexpr resourceId_t()
            : lowPart(0)
            , highPart(0)
        {
        }
 
        constexpr resourceId_t(uint64_t low, uint64_t high)
            : lowPart(low)
            , highPart(high)
        {
        }
 
        static constexpr resourceId_t Invalid()
        {
            return resourceId_t();
        }
 
        constexpr bool isValid() const
        {
            return *this != Invalid();
        }
 
        constexpr bool operator==(const resourceId_t& other) const
        {
            return highPart == other.highPart && lowPart == other.lowPart;
        }
 
        constexpr bool operator!=(const resourceId_t& other) const
        {
            return !(*this == other);
        }
 
        uint64_t lowPart;
        uint64_t highPart;
    };
 
    struct nodeIdTag {};
 
    using nodeId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), nodeIdTag>;
 
    enum ERamsesShellType
    {
        ERamsesShellType_None = 0,
        ERamsesShellType_Console,
        ERamsesShellType_Default
    };
 
    enum class ELogLevel
    {
        Off,
        Fatal,
        Error,
        Warn,
        Info,
        Debug,
        Trace
    };
 
    using LogHandlerFunc = std::function<void(ELogLevel, const std::string&, const std::string&)>;
 
    struct resourceCacheFlagTag {};
 
    using resourceCacheFlag_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), resourceCacheFlagTag>;
 
    constexpr const resourceCacheFlag_t ResourceCacheFlag_DoNotCache = resourceCacheFlag_t::Invalid();
 
    struct pickableObjectTag {};
 
    using pickableObjectId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), pickableObjectTag>;
 
    using binaryShaderFormatId_t = StronglyTypedValue<uint32_t, 0, struct binaryShaderFormatIdTag>;
 
    struct sceneObjectTag {};
 
    using sceneObjectId_t = StronglyTypedValue<uint64_t, 0, sceneObjectTag>;
 
    struct waylandIviSurfaceIdTag {};
 
    using waylandIviSurfaceId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), waylandIviSurfaceIdTag>;
 
 
    struct waylandIviLayerIdTag {};
 
    using waylandIviLayerId_t = StronglyTypedValue<uint32_t, std::numeric_limits<uint32_t>::max(), waylandIviLayerIdTag>;
 
    enum EClearFlags
    {
        EClearFlags_None      = 0,
 
        EClearFlags_Color     = 1 << 0,
        EClearFlags_Depth     = 1 << 1,
        EClearFlags_Stencil   = 1 << 2,
 
        EClearFlags_All       = EClearFlags_Color | EClearFlags_Depth | EClearFlags_Stencil
    };
}
 
#endif