#include <GrD3DRenderTarget.h>

Inheritance diagram for GrD3DRenderTarget:

Public Member Functions
	~GrD3DRenderTarget () override

GrBackendFormat	backendFormat () const override

const GrD3DTextureResource *	msaaTextureResource () const

GrD3DTextureResource *	msaaTextureResource ()

bool	canAttemptStencilAttachment (bool useMSAASurface) const override

GrBackendRenderTarget	getBackendRenderTarget () const override

D3D12_CPU_DESCRIPTOR_HANDLE	colorRenderTargetView () const

DXGI_FORMAT	stencilDxgiFormat () const

void	genKey (skgpu::KeyBuilder *b) const

Public Member Functions inherited from GrRenderTarget
virtual bool	alwaysClearStencil () const

GrRenderTarget *	asRenderTarget () override

const GrRenderTarget *	asRenderTarget () const override

int	numSamples () const

virtual GrBackendRenderTarget	getBackendRenderTarget () const =0

GrAttachment *	getStencilAttachment (bool useMSAASurface) const

GrAttachment *	getStencilAttachment () const

virtual bool	canAttemptStencilAttachment (bool useMSAASurface) const =0

void	attachStencilAttachment (sk_sp< GrAttachment > stencil, bool useMSAASurface)

int	numStencilBits (bool useMSAASurface) const

int	getSamplePatternKey ()

const skia_private::TArray< SkPoint > &	getSampleLocations ()

void	setRequiresManualMSAAResolve ()

bool	requiresManualMSAAResolve () const

Public Member Functions inherited from GrSurface
SkISize	dimensions () const

int	width () const

int	height () const

SkRect	getBoundsRect () const

virtual GrBackendFormat	backendFormat () const =0

void	setRelease (sk_sp< skgpu::RefCntedCallback > releaseHelper)

void	setRelease (ReleaseProc proc, ReleaseCtx ctx)

virtual GrTexture *	asTexture ()

virtual const GrTexture *	asTexture () const

virtual GrRenderTarget *	asRenderTarget ()

virtual const GrRenderTarget *	asRenderTarget () const

GrInternalSurfaceFlags	flags () const

bool	readOnly () const

bool	framebufferOnly () const

bool	isProtected () const

void	setFramebufferOnly ()

Public Member Functions inherited from GrGpuResource
bool	wasDestroyed () const

const GrDirectContext *	getContext () const

GrDirectContext *	getContext ()

size_t	gpuMemorySize () const

UniqueID	uniqueID () const

const skgpu::UniqueKey &	getUniqueKey () const

std::string	getLabel () const

void	setLabel (std::string_view label)

CacheAccess	cacheAccess ()

const CacheAccess	cacheAccess () const

ProxyAccess	proxyAccess ()

ResourcePriv	resourcePriv ()

const ResourcePriv	resourcePriv () const

virtual void	dumpMemoryStatistics (SkTraceMemoryDump *traceMemoryDump) const

virtual const char *	getResourceType () const =0

Public Member Functions inherited from GrIORef< GrGpuResource >
bool	unique () const

void	ref () const

void	unref () const

void	refCommandBuffer () const

void	unrefCommandBuffer () const

Public Member Functions inherited from SkNoncopyable
	SkNoncopyable ()=default

	SkNoncopyable (SkNoncopyable &&)=default

SkNoncopyable &	operator= (SkNoncopyable &&)=default

Public Member Functions inherited from GrD3DTextureResource
	GrD3DTextureResource (const GrD3DTextureResourceInfo &info, sk_sp< GrD3DResourceState > state)

virtual	~GrD3DTextureResource ()

ID3D12Resource *	d3dResource () const

DXGI_FORMAT	dxgiFormat () const

GrBackendFormat	getBackendFormat () const

sk_sp< Resource >	resource () const

uint32_t	mipLevels () const

sk_sp< GrD3DResourceState >	grD3DResourceState () const

D3D12_RESOURCE_STATES	currentState () const

void	setResourceState (const GrD3DGpu *gpu, D3D12_RESOURCE_STATES newResourceState, unsigned int subresource=D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES)

void	prepareForPresent (GrD3DGpu *gpu)

unsigned int	sampleQualityPattern () const

void	updateResourceState (D3D12_RESOURCE_STATES newState)

void	setResourceRelease (sk_sp< GrSurface::RefCntedReleaseProc > releaseHelper)

Static Public Member Functions
static sk_sp< GrD3DRenderTarget >	MakeWrappedRenderTarget (GrD3DGpu *, SkISize, int sampleCnt, const GrD3DTextureResourceInfo &, sk_sp< GrD3DResourceState >)

Static Public Member Functions inherited from GrSurface
static size_t	ComputeSize (const GrBackendFormat &, SkISize dimensions, int colorSamplesPerPixel, skgpu::Mipmapped, bool binSize=false)

Static Public Member Functions inherited from GrGpuResource
static uint32_t	CreateUniqueID ()

Static Public Member Functions inherited from GrD3DTextureResource
static bool	InitTextureResourceInfo (GrD3DGpu gpu, const D3D12_RESOURCE_DESC &desc, D3D12_RESOURCE_STATES initialState, GrProtected, D3D12_CLEAR_VALUE , GrD3DTextureResourceInfo *)

static std::pair< GrD3DTextureResourceInfo, sk_sp< GrD3DResourceState > >	CreateMSAA (GrD3DGpu *gpu, SkISize dimensions, int sampleCnt, const GrD3DTextureResourceInfo &info, SkColor4f clearColor)

Protected Member Functions
	GrD3DRenderTarget (GrD3DGpu *gpu, SkISize dimensions, const GrD3DTextureResourceInfo &info, sk_sp< GrD3DResourceState > state, const GrD3DTextureResourceInfo &msaaInfo, sk_sp< GrD3DResourceState > msaaState, const GrD3DDescriptorHeap::CPUHandle &colorRenderTargetView, const GrD3DDescriptorHeap::CPUHandle &resolveRenderTargetView, std::string_view label)

	GrD3DRenderTarget (GrD3DGpu *gpu, SkISize dimensions, const GrD3DTextureResourceInfo &info, sk_sp< GrD3DResourceState > state, const GrD3DDescriptorHeap::CPUHandle &renderTargetView, std::string_view label)

void	onAbandon () override

void	onRelease () override

size_t	onGpuMemorySize () const override

void	onSetLabel () override

Protected Member Functions inherited from GrRenderTarget
	GrRenderTarget (GrGpu *, const SkISize &, int sampleCount, GrProtected, std::string_view label, sk_sp< GrAttachment > stenicl=nullptr)

	~GrRenderTarget () override

void	onAbandon () override

void	onRelease () override

Protected Member Functions inherited from GrSurface
void	setGLRTFBOIDIs0 ()

bool	glRTFBOIDis0 () const

void	setRequiresManualMSAAResolve ()

bool	requiresManualMSAAResolve () const

void	setReadOnly ()

void	setVkRTSupportsInputAttachment ()

	GrSurface (GrGpu *gpu, const SkISize &dimensions, skgpu::Protected isProtected, std::string_view label)

	~GrSurface () override

void	onRelease () override

void	onAbandon () override

Protected Member Functions inherited from GrGpuResource
void	registerWithCache (skgpu::Budgeted)

void	registerWithCacheWrapped (GrWrapCacheable)

	GrGpuResource (GrGpu *, std::string_view label)

virtual	~GrGpuResource ()

GrGpu *	getGpu () const

virtual void	onRelease ()

virtual void	onAbandon ()

virtual void	setMemoryBacking (SkTraceMemoryDump *, const SkString &) const

SkString	getResourceName () const

void	dumpMemoryStatisticsPriv (SkTraceMemoryDump traceMemoryDump, const SkString &resourceName, const char type, size_t size) const

Protected Member Functions inherited from GrIORef< GrGpuResource >
	GrIORef ()

bool	internalHasRef () const

bool	internalHasNoCommandBufferUsages () const

void	addInitialRef () const

Protected Member Functions inherited from GrD3DTextureResource
void	releaseResource (GrD3DGpu *gpu)

Additional Inherited Members
Public Types inherited from GrSurface
typedef void *	ReleaseCtx

typedef void(*	ReleaseProc) (ReleaseCtx)

Public Types inherited from GrIORef< GrGpuResource >
enum	LastRemovedRef

Protected Attributes inherited from GrD3DTextureResource
GrD3DTextureResourceInfo	fInfo

sk_sp< GrD3DResourceState >	fState

Detailed Description

Definition at line 25 of file GrD3DRenderTarget.h.

Constructor & Destructor Documentation

◆ ~GrD3DRenderTarget()

GrD3DRenderTarget::~GrD3DRenderTarget ( )

override

Definition at line 137 of file GrD3DRenderTarget.cpp.

                                      {
    // either release or abandon should have been called by the owner of this object.
    SkASSERT(!fMSAATextureResource);
}

◆ GrD3DRenderTarget() [1/2]

GrD3DRenderTarget::GrD3DRenderTarget	(	GrD3DGpu *	gpu,
		SkISize	dimensions,
		const GrD3DTextureResourceInfo &	info,
		sk_sp< GrD3DResourceState >	state,
		const GrD3DTextureResourceInfo &	msaaInfo,
		sk_sp< GrD3DResourceState >	msaaState,
		const GrD3DDescriptorHeap::CPUHandle &	colorRenderTargetView,
		const GrD3DDescriptorHeap::CPUHandle &	resolveRenderTargetView,
		std::string_view	label
	)

protected

Definition at line 45 of file GrD3DRenderTarget.cpp.

        : GrSurface(gpu, dimensions, info.fProtected, label)
        , GrD3DTextureResource(info, std::move(state))
        // for the moment we only support 1:1 color to stencil
        , GrRenderTarget(gpu, dimensions, msaaInfo.fSampleCount, info.fProtected, label)
        , fMSAATextureResource(new GrD3DTextureResource(msaaInfo, std::move(msaaState)))
        , fColorRenderTargetView(colorRenderTargetView)
        , fResolveRenderTargetView(resolveRenderTargetView) {
    SkASSERT(info.fProtected == msaaInfo.fProtected);
    SkASSERT(msaaInfo.fSampleCount > 1);
}

◆ GrD3DRenderTarget() [2/2]

GrD3DRenderTarget::GrD3DRenderTarget	(	GrD3DGpu *	gpu,
		SkISize	dimensions,
		const GrD3DTextureResourceInfo &	info,
		sk_sp< GrD3DResourceState >	state,
		const GrD3DDescriptorHeap::CPUHandle &	renderTargetView,
		std::string_view	label
	)

protected

Definition at line 84 of file GrD3DRenderTarget.cpp.

        : GrSurface(gpu, dimensions, info.fProtected, label)
        , GrD3DTextureResource(info, std::move(state))
        , GrRenderTarget(gpu, dimensions, info.fSampleCount, info.fProtected, label)
        , fMSAATextureResource(nullptr)
        , fColorRenderTargetView(renderTargetView) {}

Member Function Documentation

◆ backendFormat()

GrBackendFormat GrD3DRenderTarget::backendFormat ( ) const

inlineoverridevirtual

Implements GrSurface.

Reimplemented in GrD3DTextureRenderTarget.

Definition at line 32 of file GrD3DRenderTarget.h.

32{ return this->getBackendFormat(); }

GrD3DTextureResource::getBackendFormat

GrBackendFormat getBackendFormat() const

Definition: GrD3DTextureResource.h:39

◆ canAttemptStencilAttachment()

bool GrD3DRenderTarget::canAttemptStencilAttachment ( bool useMSAASurface ) const

inlineoverridevirtual

Implements GrRenderTarget.

Definition at line 42 of file GrD3DRenderTarget.h.

                                                                         {
        SkASSERT(useMSAASurface == (this->numSamples() > 1));
        return true;
    }

◆ colorRenderTargetView()

D3D12_CPU_DESCRIPTOR_HANDLE GrD3DRenderTarget::colorRenderTargetView ( ) const

inline

Definition at line 49 of file GrD3DRenderTarget.h.

                                                              {
        return fColorRenderTargetView.fHandle;
    }

◆ genKey()

void GrD3DRenderTarget::genKey ( skgpu::KeyBuilder * b ) const

Definition at line 200 of file GrD3DRenderTarget.cpp.

                                                       {
    b->add32(this->dxgiFormat());
    b->add32(this->numSamples());
    b->add32(this->stencilDxgiFormat());
#ifdef SK_DEBUG
    if (const GrAttachment* stencil = this->getStencilAttachment()) {
        SkASSERT(stencil->numSamples() == this->numSamples());
    }
#endif
    b->add32(this->sampleQualityPattern());
}

◆ getBackendRenderTarget()

GrBackendRenderTarget GrD3DRenderTarget::getBackendRenderTarget ( ) const

overridevirtual

Implements GrRenderTarget.

Definition at line 183 of file GrD3DRenderTarget.cpp.

                                                                      {
    return GrBackendRenderTarget(this->width(), this->height(), fInfo, this->grD3DResourceState());
}

◆ MakeWrappedRenderTarget()

sk_sp< GrD3DRenderTarget > GrD3DRenderTarget::MakeWrappedRenderTarget	(	GrD3DGpu *	gpu,
		SkISize	dimensions,
		int	sampleCnt,
		const GrD3DTextureResourceInfo &	info,
		sk_sp< GrD3DResourceState >	state
	)

static

Definition at line 96 of file GrD3DRenderTarget.cpp.

                                             {
    SkASSERT(info.fResource.get());
    SkASSERT(info.fLevelCount == 1);
    SkASSERT(sampleCnt >= 1 && info.fSampleCount >= 1);
 
    int wrappedTextureSampleCnt = static_cast<int>(info.fSampleCount);
    if (sampleCnt != wrappedTextureSampleCnt && wrappedTextureSampleCnt != 1) {
        return nullptr;
    }
 
    GrD3DDescriptorHeap::CPUHandle renderTargetView =
            gpu->resourceProvider().createRenderTargetView(info.fResource.get());
 
    // create msaa surface if necessary
    GrD3DRenderTarget* d3dRT;
    if (sampleCnt != wrappedTextureSampleCnt) {
        GrD3DTextureResourceInfo msInfo;
        sk_sp<GrD3DResourceState> msState;
        // for wrapped MSAA surface we assume clear to white
        SkColor4f clearColor = { 1, 1, 1, 1 };
        std::tie(msInfo, msState) =
                GrD3DTextureResource::CreateMSAA(gpu, dimensions, sampleCnt, info, clearColor);
 
        GrD3DDescriptorHeap::CPUHandle msaaRenderTargetView =
                gpu->resourceProvider().createRenderTargetView(msInfo.fResource.get());
 
        d3dRT = new GrD3DRenderTarget(gpu, dimensions, info, std::move(state), msInfo,
                                      std::move(msState), msaaRenderTargetView, renderTargetView,
                                      kWrapped,
                                      /*label=*/"MakeWrappedRenderTargetWithMSAASurface");
    } else {
        d3dRT = new GrD3DRenderTarget(
                gpu, dimensions, info, std::move(state), renderTargetView, kWrapped,
                /*label=*/"MakeWrappedRenderTarget");
    }
 
    return sk_sp<GrD3DRenderTarget>(d3dRT);
}

◆ msaaTextureResource() [1/2]

GrD3DTextureResource * GrD3DRenderTarget::msaaTextureResource ( )

Definition at line 154 of file GrD3DRenderTarget.cpp.

                                                             {
    auto* constThis = const_cast<const GrD3DRenderTarget*>(this);
    return const_cast<GrD3DTextureResource*>(constThis->msaaTextureResource());
}

◆ msaaTextureResource() [2/2]

const GrD3DTextureResource * GrD3DRenderTarget::msaaTextureResource ( ) const

If this render target is multisampled, this returns the MSAA texture for rendering. This will be different than this when we have separate render/resolve images. If not multisampled returns nullptr.

Definition at line 142 of file GrD3DRenderTarget.cpp.

                                                                         {
    if (this->numSamples() == 1) {
        SkASSERT(!fMSAATextureResource);
        return nullptr;
    }
    if (fMSAATextureResource) {
        return fMSAATextureResource.get();
    }
    SkASSERT(!fMSAATextureResource);
    return this;
}

◆ onAbandon()

void GrD3DRenderTarget::onAbandon ( )

overrideprotectedvirtual

Overridden to abandon any internal handles, ptrs, etc to backend API resources. This may be called when the underlying 3D context is no longer valid and so no backend API calls should be made.

Reimplemented from GrGpuResource.

Reimplemented in GrD3DTextureRenderTarget.

Definition at line 177 of file GrD3DRenderTarget.cpp.

                                  {
    this->releaseInternalObjects();
    this->releaseResource(this->getD3DGpu());
    GrRenderTarget::onAbandon();
}

◆ onGpuMemorySize()

size_t GrD3DRenderTarget::onGpuMemorySize ( ) const

inlineoverrideprotectedvirtual

Implements GrGpuResource.

Definition at line 80 of file GrD3DRenderTarget.h.

                                            {
        int numColorSamples = this->numSamples();
        if (numColorSamples > 1) {
            // Add one to account for the resolved VkImage.
            numColorSamples += 1;
        }
        return GrSurface::ComputeSize(
                this->backendFormat(), this->dimensions(), numColorSamples, skgpu::Mipmapped::kNo);
    }

◆ onRelease()

void GrD3DRenderTarget::onRelease ( )

overrideprotectedvirtual

Overridden to free GPU resources in the backend API.

Reimplemented from GrGpuResource.

Reimplemented in GrD3DTextureRenderTarget.

Definition at line 171 of file GrD3DRenderTarget.cpp.

                                  {
    this->releaseInternalObjects();
    this->releaseResource(this->getD3DGpu());
    GrRenderTarget::onRelease();
}

◆ onSetLabel()

void GrD3DRenderTarget::onSetLabel ( )

overrideprotectedvirtual

Implements GrGpuResource.

Definition at line 212 of file GrD3DRenderTarget.cpp.

                                   {
    SkASSERT(this->d3dResource());
    if (!this->getLabel().empty()) {
        if (fMSAATextureResource) {
            SkASSERT(fMSAATextureResource->d3dResource());
            const std::wstring suffix = GrD3DMultiByteToWide(this->getLabel());
            const std::wstring msaaLabel = L"_Skia_MSAA_" + suffix;
            fMSAATextureResource->d3dResource()->SetName(msaaLabel.c_str());
            const std::wstring resolveLabel = L"_Skia_Resolve_" + suffix;
            this->d3dResource()->SetName(resolveLabel.c_str());
        } else {
            const std::wstring label = L"_Skia_" + GrD3DMultiByteToWide(this->getLabel());
            this->d3dResource()->SetName(label.c_str());
        }
    }
}

◆ stencilDxgiFormat()

DXGI_FORMAT GrD3DRenderTarget::stencilDxgiFormat ( ) const

Definition at line 192 of file GrD3DRenderTarget.cpp.

                                                       {
    if (auto stencil = this->getStencilAttachment()) {
        auto d3dStencil = static_cast<GrD3DAttachment*>(stencil);
        return d3dStencil->dxgiFormat();
    }
    return DXGI_FORMAT_UNKNOWN;
}

The documentation for this class was generated from the following files:

third_party/skia/src/gpu/ganesh/d3d/GrD3DRenderTarget.h
third_party/skia/src/gpu/ganesh/d3d/GrD3DRenderTarget.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~GrD3DRenderTarget()

◆ GrD3DRenderTarget() [1/2]

◆ GrD3DRenderTarget() [2/2]

Member Function Documentation

◆ backendFormat()

◆ canAttemptStencilAttachment()

◆ colorRenderTargetView()

◆ genKey()

◆ getBackendRenderTarget()

◆ MakeWrappedRenderTarget()

◆ msaaTextureResource() [1/2]

◆ msaaTextureResource() [2/2]

◆ onAbandon()

◆ onGpuMemorySize()

◆ onRelease()

◆ onSetLabel()

◆ stencilDxgiFormat()