RenderCapture.h

浏览该文件的文档.

#pragma once
 
// Capability interface: render-frame capture and scene inspection for
// devtools / MCP. Provided by the graphics module (which may reach into scene
// for the entity-id mask and visible-entity JSON).
 
#include "common/Export.h"
#include "common/Result.h"
 
#include <cstdint>
#include <string>
 
namespace eve {
 
struct EVENGINE_API_FOUNDATION_INLINE RenderStatusInfo {
    int width = 0, height = 0, pixelWidth = 0, pixelHeight = 0;
    bool had3DThisFrame = false;
    bool readbackEnabled = false;
    std::string backend;
};
 
struct EVENGINE_API_FOUNDATION_INLINE Renderable3DInfo {
    std::uint32_t entityId = 0;
    std::uint32_t generation = 0;
    float x = 0.f, y = 0.f, z = 0.f;
    float tintR = 1.f, tintG = 1.f, tintB = 1.f, tintA = 1.f;
    float metallic = 0.f, roughness = 0.45f, parallaxScale = 0.f;
    bool visible = true, receiveLight = true, castShadow = true, receiveShadow = true;
    bool hasPackedMaterial = false, hasTexture = false, hasShader = false;
};
 
class EVENGINE_API_FOUNDATION_INLINE IRenderCapture {
public:
    static constexpr const char* capabilityName = "IRenderCapture";
 
    virtual ~IRenderCapture() = default;
 
    virtual RenderStatusInfo status() const = 0;
    virtual void setReadbackEnabled(bool enabled) = 0;
    virtual bool savePng(const std::string& path, int* outWidth, int* outHeight,
                         std::string* err) = 0;
    virtual std::string capturePngDataUrl() = 0;
 
    virtual bool ensureCamera() = 0;
    virtual bool setCameraPose(float ex, float ey, float ez, float tx, float ty, float tz,
                               float fovYDeg) = 0;
    virtual bool setCameraPoseYawPitch(float ex, float ey, float ez, float yawDeg,
                                       float pitchDeg, float fovYDeg) = 0;
    virtual std::string cameraPoseJson() = 0;
 
    [[nodiscard]] virtual Result<Renderable3DInfo> inspectRenderable3D(
        std::uint32_t entityId, std::uint32_t generation) = 0;
 
    virtual std::string visibleEntitiesJson(float fovYDeg, bool* ok) = 0;
    virtual std::string visibleEntitiesJsonAt(float ex, float ey, float ez, float tx, float ty,
                                              float tz, float fovYDeg, bool* ok) = 0;
    virtual std::string entityIdMaskJson(int* outWidth, int* outHeight, bool* ok) = 0;
    virtual bool entityIdMaskPng(const std::string& path, std::string* err) = 0;
    virtual bool gbufferPng(const std::string& name, const std::string& path,
                            std::string* err) = 0;
};
 
}  // namespace eve