VisualizerDebuggingState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
 
#ifndef UE_VISUALIZER_DEBUGGING_STATE
    #define UE_VISUALIZER_DEBUGGING_STATE !UE_BUILD_SHIPPING
#endif
 
struct FGuid;
 
namespace UE::Core
{
 
struct FVisualizerDebuggingStateImpl;
 
enum class EVisualizerDebuggingStateResult : uint8
{
    Success,
    StringCollision,
    FeatureDisabled,
};
 
struct FVisualizerDebuggingState
{
    FVisualizerDebuggingState();
 
    FVisualizerDebuggingState(const FVisualizerDebuggingState&) = delete;
    void operator=(const FVisualizerDebuggingState&) = delete;
 
    FVisualizerDebuggingState(FVisualizerDebuggingState&&) = delete;
    void operator=(FVisualizerDebuggingState&&) = delete;
 
    ~FVisualizerDebuggingState();
 
#if !UE_VISUALIZER_DEBUGGING_STATE
 
    [[nodiscard]] static EVisualizerDebuggingStateResult Assign(const FGuid& UniqueId, void* DebugPtr)
    {
        return EVisualizerDebuggingStateResult::FeatureDisabled;
    }
 
#else
 
    [[nodiscard]] CORE_API static EVisualizerDebuggingStateResult Assign(const FGuid& UniqueId, void* DebugPtr);
 
 
protected:
    // protected in order to support automation test introspection
 
    EVisualizerDebuggingStateResult AssignImpl(const FGuid& UniqueId, void* DebugPtr);
 
    void* Find(const FGuid& UniqueId) const;
 
    const char* GuidString = nullptr;
 
    void** Ptrs = nullptr;
 
    FVisualizerDebuggingStateImpl* PimplData = nullptr;
 
#endif
};
 
} // namespace UE::Core