eve::graphics_editing::GraphicsOffscreenPreviewService类 参考

Concrete Graphics/Canvas preview bridge with revision-safe artifact storage. 更多...

#include <OffscreenPreview.h>

Public 类型
using	DrawCallback = std::function< Result< void >(graphics::Graphics *, graphics::Canvas *)>

Public 成员函数
	GraphicsOffscreenPreviewService (graphics::Graphics *graphics, graphics::ICanvasFactory *canvases, graphics::ICanvasTarget *targets)
	Bind borrowed draw, allocation and target-control interfaces.
	~GraphicsOffscreenPreviewService ()
	Graphics offscreen preview service.
	GraphicsOffscreenPreviewService (const GraphicsOffscreenPreviewService &)=delete
GraphicsOffscreenPreviewService &	operator= (const GraphicsOffscreenPreviewService &)=delete
Result< OffscreenPreviewArtifact >	render (const OffscreenPreviewRequest &request, const DrawCallback &draw, int maximumDimension=4096, std::uint64_t maximumPixels=16777216)
	Clear, draw and read back one isolated offscreen Canvas.
Result< const image::ImageData * >	image (const std::string &handle, Revision currentRevision) const
	Borrow pixels only when the requested source revision still matches.
Result< void >	release (const std::string &handle)
	Remove an in-memory readback artifact.

详细描述

Concrete Graphics/Canvas preview bridge with revision-safe artifact storage.

在文件 OffscreenPreview.h 第 47 行定义.

成员类型定义说明

DrawCallback

using eve::graphics_editing::GraphicsOffscreenPreviewService::DrawCallback = std::function<Result<void>(graphics::Graphics*, graphics::Canvas*)>

在文件 OffscreenPreview.h 第 49 行定义.

构造及析构函数说明

GraphicsOffscreenPreviewService() [1/2]

eve::graphics_editing::GraphicsOffscreenPreviewService::GraphicsOffscreenPreviewService	(	graphics::Graphics *	graphics,
		graphics::ICanvasFactory *	canvases,
		graphics::ICanvasTarget *	targets
	)

Bind borrowed draw, allocation and target-control interfaces.

在文件 OffscreenPreview.cpp 第 35 行定义.

~GraphicsOffscreenPreviewService()

eve::graphics_editing::GraphicsOffscreenPreviewService::~GraphicsOffscreenPreviewService ( )

default

Graphics offscreen preview service.

GraphicsOffscreenPreviewService() [2/2]

eve::graphics_editing::GraphicsOffscreenPreviewService::GraphicsOffscreenPreviewService ( const GraphicsOffscreenPreviewService &  )

delete

成员函数说明

image()

Result< const image::ImageData * > eve::graphics_editing::GraphicsOffscreenPreviewService::image	(	const std::string &	handle,
		Revision	currentRevision
	)		const

Borrow pixels only when the requested source revision still matches.

在文件 OffscreenPreview.cpp 第 104 行定义.

引用了 found , 以及 handle.

operator=()

GraphicsOffscreenPreviewService & eve::graphics_editing::GraphicsOffscreenPreviewService::operator= ( const GraphicsOffscreenPreviewService &  )

delete

release()

Result< void > eve::graphics_editing::GraphicsOffscreenPreviewService::release

(

const std::string &

handle

)

Remove an in-memory readback artifact.

在文件 OffscreenPreview.cpp 第 118 行定义.

引用了 handle.

render()

Result< OffscreenPreviewArtifact > eve::graphics_editing::GraphicsOffscreenPreviewService::render	(	const OffscreenPreviewRequest &	request,
		const DrawCallback &	draw,
		int	maximumDimension = 4096,
		std::uint64_t	maximumPixels = 16777216
	)

Clear, draw and read back one isolated offscreen Canvas.

在文件 OffscreenPreview.cpp 第 45 行定义.

引用了 eve::graphics::Canvas::clear(), draw, eve::Result< T >::failure(), eve::graphics_editing::OffscreenPreviewArtifact::handle, eve::graphics_editing::OffscreenPreviewArtifact::height, key, eve::graphics::Canvas::newImageData(), eve::Result< T >::ok(), pixels, eve::graphics_editing::OffscreenPreviewArtifact::previewId, previous, request, eve::graphics_editing::OffscreenPreviewArtifact::sourceRevision, eve::Result< T >::status() , 以及 eve::graphics_editing::OffscreenPreviewArtifact::width.

被这些函数引用 eve::editor::OffscreenMaterialPreviewRenderer::render(), eve::particles_graphics_editing::ParticleOffscreenPreviewService::render(), eve::editor::StylizeOffscreenPreviewService::render(), eve::editor::SurfaceFluidOffscreenPreviewService::render() , 以及 eve::editor::UiOffscreenPreviewRenderer::render().

---

该类的文档由以下文件生成:

• src/modules/graphics/editing/OffscreenPreview.h
• src/modules/graphics/editing/OffscreenPreview.cpp