oa::FnTexture

FnTexture namespace in the OA Core public surface.

NsC++ public headers

Public Functions

oa::Status oa::FnTexture::blit(const BlitDesc & inDesc)

oa::Status oa::FnTexture::clear(const Texture & inTarget, ClearColor inColor)

oa::Status oa::FnTexture::copyToHost(oa::Engine & inEngine, const Texture & inTexture, void * outHost, oa::U64 inBytes)

oa::Result<Texture> oa::FnTexture::fromImage(oa::Engine & inEngine, const oa::Image & inImage)

oa::Result<Texture> oa::FnTexture::fromPixels(oa::Engine & inEngine, oa::Span<const oa::U8> inRgba, oa::I32 inWidth, oa::I32 inHeight)

Function Documentation

oa::Status oa::FnTexture::blit(
	const BlitDesc & inDesc
)

No public source comment is attached to this declaration.

Parameters

inDesc

const BlitDesc &

—

Returns

oa::Status

The declared return value.

oa::Status oa::FnTexture::clear(
	const Texture & inTarget,
	ClearColor inColor
)

No public source comment is attached to this declaration.

Parameters

inTarget

const Texture &

—

inColor

ClearColor

—

Returns

oa::Status

The declared return value.

oa::Status oa::FnTexture::copyToHost(
	oa::Engine & inEngine,
	const Texture & inTexture,
	void * outHost,
	oa::U64 inBytes
)

Synchronous semantic readback for buffer-backed RGBA8 textures. Any work recorded on the texture's engine completes before bytes are copied.

Parameters

inEngine

oa::Engine &

—

inTexture

const Texture &

—

outHost

void *

—

inBytes

oa::U64

—

Returns

oa::Status

The declared return value.

oa::Result<Texture> oa::FnTexture::fromImage(
	oa::Engine & inEngine,
	const oa::Image & inImage
)

Record conversion from a validated single semantic image to packed RGBA8. Every supported oa::Image layout and channel format is interpreted explicitly.

Parameters

inEngine

oa::Engine &

—

inImage

const oa::Image &

—

Returns

oa::Result<Texture>

The declared return value.

oa::Result<Texture> oa::FnTexture::fromPixels(
	oa::Engine & inEngine,
	oa::Span<const oa::U8> inRgba,
	oa::I32 inWidth,
	oa::I32 inHeight
)

Synchronously upload one exact packed-RGBA8 host image.

Parameters

inEngine

oa::Engine &

—

inRgba

oa::Span<const oa::U8>

—

inWidth

oa::I32

—

inHeight

oa::I32

—

Returns

oa::Result<Texture>

The declared return value.