GxDefine.h

Go to the documentation of this file.

//===========================================================================
//===========================================================================
#pragma once
 
#if !defined(GX_EVALUATION)
#define GX_EVALUATION 0
#endif //GX_EVALUATION
 
#if defined(_MASTER)
#define GX_DEVELOP                  0       
#define GX_MASTER                   1       
#define GX_ASSERT_ENABLE            0       
#else //_MASTER
#define GX_DEVELOP                  1
#define GX_MASTER                   0
#define GX_ASSERT_ENABLE            1
#endif // !_MASTER
 
// エディターモード
#if defined(_WINDOWS) && GX_DEVELOP
#define GX_EDITOR                   1
#else //_WINDOWS && GX_DEVELOP
#define GX_EDITOR                   0
#endif // !(_WINDOWS && GX_DEVELOP)
 
//  ソースコード内の文字列定数のエンコード
#define GX_STRING_ENCODE_SJIS           0           
#define GX_STRING_ENCODE_EUC            1           
#define GX_STRING_ENCODE_UTF8           2           
 
// オンラインドキュメント用アドレス
#define GX_WIKI_ADDRESS "https://d2bamn6912wffr.cloudfront.net/OROCHI/doc/"
 
// ユニットのプロファイリング
#ifndef GX_USE_UNIT_PROFILE
#if GX_DEVELOP
#define GX_USE_UNIT_PROFILE 1
#else
#define GX_USE_UNIT_PROFILE 0
#endif //GX_DEVELOP
#endif //GX_USE_UNIT_PROFILE
 
// 開発用メモリ確保が有効かどうか
#ifndef GX_DEBUG_NEW
#if GX_DEVELOP
#define GX_DEBUG_NEW            1
#else
#define GX_DEBUG_NEW            0
#endif //GX_DEVELOP
#endif  // GX_DEBUG_NEW
 
// メモリ確保まわり
#ifndef GX_USE_DEFAULT_ALLOCATOR
#define GX_USE_DEFAULT_ALLOCATOR        0
#endif
 
// GxCore内スレッドのCPU割り当て
// 非同期ロードスレッドのCPU割り当て
#ifndef GX_ASYNC_LOAD_THREAD_CPU_INDEX
#define GX_ASYNC_LOAD_THREAD_CPU_INDEX              (-1)
#endif // GX_ASYNC_LOAD_THREAD_CPU_INDEX
 
// GxCore内スレッドスタックサイズ
// ワーカースレッドのスタックサイズ
#ifndef GX_WORKER_THREAD_STACKSIZE
#define GX_WORKER_THREAD_STACKSIZE                  (0xC000)    // 48KB
#endif // GX_WORKER_THREAD_STACKSIZE
 
// 描画スレッドのスタックサイズ
#ifndef GX_RENDER_THREAD_STACKSIZE
#define GX_RENDER_THREAD_STACKSIZE                  (0xC000)    // 48KB
#endif // GX_RENDER_THREAD_STACKSIZE
 
// 非同期ロードスレッドのスタックサイズ
#ifndef GX_ASYNC_LOAD_THREAD_STACKSIZE
#define GX_ASYNC_LOAD_THREAD_STACKSIZE              (0xC000)    // 48KB
#endif // GX_ASYNC_LOAD_THREAD_STACKSIZE
 
// GxVectorのゼロディバイドワーニング
#ifndef GX_VECTOR_ZERO_DIVIDE_WARNING_ENABLE
#define GX_VECTOR_ZERO_DIVIDE_WARNING_ENABLE        0           // 無効
#endif //GX_VECTOR_ZERO_DIVIDE_WARNING_ENABLE
 
// 各マップにFP16フォーマットを使用する
#define GX_USE_FP16MAP
 
// シェーダーデバッグ有効
#define GX_SHADER_DEBUG 0
 
// バウンディングスフィアのサイズを変えずメッシュのスケーリングを変更できる機能
// note:
// アプリによるユニットへのスケール処理のタイミングによっては正しく動かない場合があります。
// その場合はPauseボタンでゲームを止めてから利用ください。
#define GX_PS_PROFILING 0
 
//===========================================================================
//===========================================================================
#define GX_DIRECTX_VERSION_INVALID      0x1000
#define GX_DIRECTX_VERSION_9_1          0x9100
#define GX_DIRECTX_VERSION_9_2          0x9200
#define GX_DIRECTX_VERSION_9_3          0x9300
#define GX_DIRECTX_VERSION_10_0         0xa000
#define GX_DIRECTX_VERSION_10_1         0xa100
#define GX_DIRECTX_VERSION_11_0         0xb000
#define GX_DIRECTX_VERSION_11_1         0xb100
#define GX_DIRECTX_VERSION_12_0         0xc000
#define GX_DIRECTX_VERSION_12_1         0xc100
#define GX_DIRECTX_VERSION_12_2         0xc200
 
#define GX_USE_DX10 (GX_DIRECTX_VERSION_10_0 <= GX_DIRECTX_VERSION && GX_DIRECTX_VERSION < GX_DIRECTX_VERSION_11_0)
#define GX_USE_DX11 (GX_DIRECTX_VERSION_11_0 <= GX_DIRECTX_VERSION && GX_DIRECTX_VERSION < GX_DIRECTX_VERSION_12_0)
#define GX_USE_DX12 (GX_DIRECTX_VERSION_12_0 <= GX_DIRECTX_VERSION)
 
//===========================================================================
//===========================================================================
#define GX_OPENGL_VERSION_INVALID   0
#define GX_OPENGL_VERSION_4_0       40
#define GX_OPENGL_VERSION_4_1       41
#define GX_OPENGL_VERSION_4_2       42
#define GX_OPENGL_VERSION_4_3       43
#define GX_OPENGL_VERSION_4_4       44
#define GX_OPENGL_VERSION_4_5       45
#define GX_OPENGL_VERSION_4_6       46
 
//===========================================================================
//===========================================================================
#define GX_SHADER_MODEL_1       10
#define GX_SHADER_MODEL_2       20
#define GX_SHADER_MODEL_3       30
#define GX_SHADER_MODEL_4       40
#define GX_SHADER_MODEL_5       50
#define GX_SHADER_MODEL_6       60
 
#if defined(_PS4)
#include "PS4/GxDefinePS4.h"
#elif defined(_WINDOWS)
#include "GxDefineWindows.h"
#elif defined(_NX64)
#include "NX64/GxDefineNX64.h"
#elif defined(_PS5)
#include "PS5/GxDefinePS5.h"
#elif defined(_XBOX_XS)
#include "XBOX_XS/GxDefineXboxXS.h"
#endif //_XBOX_XS
 
GX_CORE_NAMESPACE_BEGIN()
//===========================================================================
//===========================================================================
struct b32_
{
public:
    constexpr b32_(void) : _boolean(0) {}
    constexpr b32_(u32 boolean) : _boolean(boolean) {}
    u32 _boolean;   
};
 
struct b32 : public b32_
{
public:
    constexpr b32(void) : b32_() {}
    ~b32(void) {}
    constexpr b32(bool boolean) : b32_(static_cast<u32>(boolean)) {}
    constexpr b32(const b32_& boolean) : b32_(boolean._boolean) {}
    constexpr operator bool(void) const { return _boolean ? true : false; }
    constexpr const b32& operator &=(const b32& boolean) { _boolean &= boolean._boolean; return *this; }
};
 
//===========================================================================
//===========================================================================
struct GX_ENUM
{
public:
    GX_CSTR     _name;          
    s32         _index;         
};
 
#if GX_DEVELOP
struct GX_FLAG
{
public:
    GX_CSTR     _name;          
    u32         _flag;          
};
#endif //GX_DEVELOP
 
//===========================================================================
//===========================================================================
using GxTypedObject = void; 
using GX_HANDLE = u32;      
 
//===========================================================================
//===========================================================================
enum class GX_ENDIAN
{
    BIG = 0,                        
    LITTLE,                         
 
#if GX_BIG_ENDIAN
    NATIVE = BIG                    
#else   // GX_BIG_ENDIAN
    NATIVE = LITTLE                 
#endif  // !GX_BIG_ENDIAN
};
 
#if defined(_WINDOWS) && GX_DEVELOP
static constexpr GX_ENDIAN getEndian(GX_PLATFORM /*platform*/)
{
    return GX_ENDIAN::LITTLE;
}
#endif //_WINDOWS && GX_DEVELOP
 
//===========================================================================
// 出力 (共通設定)
//===========================================================================
enum class OUTPUT_TYPE
{
    ASSERT,     
    WARNING,    
    TRACE,      
    MAX,        
};
 
enum class GX_LIBRARY
{
    CORE = 0,   
    CHARACTER,  
    MOTION,     
    PHYSICS,    
    UTILITY,    
    SHADER,     
    FILTER,     
    EFFECT,     
    SOUND,      
    NETWORK,    
    P2P,        
    MOVIE,      
    HUD,        
    MAX,        
};
 
#if GX_ASSERT_ENABLE
static GX_CSTR GX_TRACE_CATEGORY_TEXT[static_cast<u32>(GX_LIBRARY::MAX) + 2] = {
    "Core",
    "Character",
    "Motion",
    "Physics",
    "Utility",
    "Shader",
    "Filter",
    "Effect",
    "Sound",
    "Network",
    "P2P",
    "Movie",
    "Hud",
    "Warning",
    "Error",
};
 
// TRACEの出力制限用定義
#define GX_TRACE_CATEGORY_NONE      0
#define GX_TRACE_CATEGORY_CORE      (1 << static_cast<u32>(GX_LIBRARY::CORE))
#define GX_TRACE_CATEGORY_CHARACTER (1 << static_cast<u32>(GX_LIBRARY::CHARACTER))
#define GX_TRACE_CATEGORY_MOTION    (1 << static_cast<u32>(GX_LIBRARY::MOTION))
#define GX_TRACE_CATEGORY_PHYSICS   (1 << static_cast<u32>(GX_LIBRARY::PHYSICS))
#define GX_TRACE_CATEGORY_UTILITY   (1 << static_cast<u32>(GX_LIBRARY::UTILITY))
#define GX_TRACE_CATEGORY_SHADER    (1 << static_cast<u32>(GX_LIBRARY::SHADER))
#define GX_TRACE_CATEGORY_FILTER    (1 << static_cast<u32>(GX_LIBRARY::FILTER))
#define GX_TRACE_CATEGORY_EFFECT    (1 << static_cast<u32>(GX_LIBRARY::EFFECT))
#define GX_TRACE_CATEGORY_SOUND     (1 << static_cast<u32>(GX_LIBRARY::SOUND))
#define GX_TRACE_CATEGORY_NETWORK   (1 << static_cast<u32>(GX_LIBRARY::NETWORK))
#define GX_TRACE_CATEGORY_P2P       (1 << static_cast<u32>(GX_LIBRARY::P2P))
#define GX_TRACE_CATEGORY_MOVIE     (1 << static_cast<u32>(GX_LIBRARY::MOVIE))
#define GX_TRACE_CATEGORY_HUD       (1 << static_cast<u32>(GX_LIBRARY::HUD))
#define GX_TRACE_CATEGORY_WARNING   (1 << static_cast<u32>(GX_LIBRARY::MAX))
#define GX_TRACE_CATEGORY_ERROR     (GX_TRACE_CATEGORY_WARNING << 1)
#define GX_TRACE_CATEGORY_MAX       GX_TRACE_CATEGORY_ERROR
#define GX_TRACE_CATEGORY_ALL       0xFFFFFFFF
 
#define GX_REPORT_LENGTH_MAX 256
extern void report(u32 category, OUTPUT_TYPE type, GX_CSTR /*file*/, s32 /*line*/, GX_CSTR /*func*/, GX_CSTR format, ...);
extern void critical_error_exit(void);
#endif //GX_ASSERT_ENABLE
 
GX_CORE_NAMESPACE_END()
 
#if GX_ASSERT_ENABLE
#define GX_ASSERT(__EXPRESSION__, ...) (void)((!!(__EXPRESSION__)) || (gx::core::report(GX_TRACE_CATEGORY_ERROR, gx::core::OUTPUT_TYPE::ASSERT, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__), 0))
#define GX_ERROR(__EXPRESSION__, ...) (void)((!!(__EXPRESSION__)) || (gx::core::report(GX_TRACE_CATEGORY_ERROR, gx::core::OUTPUT_TYPE::WARNING, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__), 0))
#define GX_WARNING(__EXPRESSION__, ...) (void)((!!(__EXPRESSION__)) || (gx::core::report(GX_TRACE_CATEGORY_WARNING, gx::core::OUTPUT_TYPE::WARNING, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__), 0))
#define GX_TRACE(__CATEGORY__, ...) gx::core::report(__CATEGORY__, gx::core::OUTPUT_TYPE::TRACE, __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
#define GX_CRITICAL_EXIT() gx::core::critical_error_exit()
#else //GX_ASSERT_ENABLE
#define GX_ASSERT(__EXPRESSION__, ...)  ((void)0)
#define GX_ERROR(__EXPRESSION__, ...)   ((void)0)
#define GX_WARNING(__EXPRESSION__, ...) ((void)0)
#define GX_TRACE(...) ((void)0)
#define GX_CRITICAL_EXIT() ((void)0)
#endif // !GX_ASSERT_ENABLE
 
#define GX_USE_DIRECTX (GX_DIRECTX_VERSION != GX_DIRECTX_VERSION_INVALID)
#define GX_USE_OPENGL (GX_OPENGL_VERSION != GX_OPENGL_VERSION_INVALID)
#define GX_USE_HLSL (!GX_USE_OPENGL)
 
#if GX_USE_DIRECTX
#if GX_DEVELOP
#define GX_DIRECTX_ASSERT(__RESULT__, __FUNCTION__) GX_ASSERT(SUCCEEDED(__RESULT__), "%s() error:0x%08X", __FUNCTION__, static_cast<u32>(__RESULT__))
#else //GX_DEVELOP
#define GX_DIRECTX_ASSERT(__RESULT__, __FUNCTION__) GX_UNUSED(__RESULT__)
#endif // !GX_DEVELOP
#endif //GX_USE_DIRECTX
 
#if GX_DEVELOP
// Masterビルドの場合は引数を無効にして空文字列を返す
#define GX_DEVELOP_FUNC_STR(__MY_STR__) (__MY_STR__)
#else //GX_DEVELOP
#define GX_DEVELOP_FUNC_STR(__MY_STR__) ("")
#endif // !GX_DEVELOP
 
#if GX_SHADER_MODEL >= GX_SHADER_MODEL_5
#define GX_ENABLE_TESSELLATION 1
#define GX_ENABLE_COMPUTE_SHADER 1
#else // GX_SHADER_MODEL >= GX_SHADER_MODEL_5
#define GX_ENABLE_TESSELLATION 0
#define GX_ENABLE_COMPUTE_SHADER 0
#endif // GX_SHADER_MODEL < GX_SHADER_MODEL_5
 
#if defined(_PS4) || defined(_NX64) || defined(_PS5)
#define ENABLE_SHADER_COMPILE 1
#define ENABLE_PARARELL_SHADER_COMPILE 1
#else //_PS4 || _NX64 || _PS5
#define ENABLE_SHADER_COMPILE 0
#define ENABLE_PARARELL_SHADER_COMPILE 0
#endif // !(_PS4 || _NX64 || _PS5)
 
// Neoを有効にするか
#if defined(_PS4)
#define GX_ENABLE_NEO 1
#else //_PS4
#define GX_ENABLE_NEO 0
#endif // !_PS4
 
// ステンシルマスク処理を有効
#if defined(_PS4)
#define GX_ENABLE_HTILE_STENCIL_MASK 1
#else //_PS4
#define GX_ENABLE_HTILE_STENCIL_MASK 0
#endif // !_PS4
 
// オクルージョンカリング有効
#if GX_USE_DX12 || defined(_PS4) || defined(_PS5)
#define GX_ENABLE_OCCLUSION_CULLING 1
#else //GX_USE_DX12 || _PS4 || _PS5
#define GX_ENABLE_OCCLUSION_CULLING 0
#endif // !(GX_USE_DX12 || _PS4 || _PS5)