GrBackendFormat Class Reference

#include <GrBackendSurface.h>

Public Member Functions
	GrBackendFormat ()
	GrBackendFormat (const GrBackendFormat &)
GrBackendFormat &	operator= (const GrBackendFormat &)
	~GrBackendFormat ()
bool	operator== (const GrBackendFormat &that) const
bool	operator!= (const GrBackendFormat &that) const
GrBackendApi	backend () const
GrTextureType	textureType () const
uint32_t	channelMask () const
GrColorFormatDesc	desc () const
GrColorType	asMockColorType () const
SkTextureCompressionType	asMockCompressionType () const
bool	isMockStencilFormat () const
GrBackendFormat	makeTexture2D () const
bool	isValid () const

Static Public Member Functions
static GrBackendFormat	MakeMock (GrColorType colorType, SkTextureCompressionType compression, bool isStencilFormat=false)

Friends
class	GrBackendSurfacePriv
class	GrBackendFormatData

Detailed Description

Definition at line 44 of file GrBackendSurface.h.

Constructor & Destructor Documentation

GrBackendFormat() [1/2]

GrBackendFormat::GrBackendFormat

(

)

Definition at line 27 of file GrBackendSurface.cpp.

: fValid(false) {}

GrBackendFormat() [2/2]

GrBackendFormat::GrBackendFormat

(

const GrBackendFormat &

that

)

Definition at line 30 of file GrBackendSurface.cpp.

        : fBackend(that.fBackend)
        , fValid(that.fValid)
        , fTextureType(that.fTextureType) {
    if (!fValid) {
        return;
    }
 
    switch (fBackend) {
        case GrBackendApi::kOpenGL:
        case GrBackendApi::kVulkan:
        case GrBackendApi::kMetal:
            fFormatData.reset();
            that.fFormatData->copyTo(fFormatData);
            break;  // fFormatData is sufficient
#ifdef SK_DIRECT3D
        case GrBackendApi::kDirect3D:
            fDxgiFormat = that.fDxgiFormat;
            break;
#endif
        case GrBackendApi::kMock:
            fMock = that.fMock;
            break;
        default:
            SK_ABORT("Unknown GrBackend");
    }
}

~GrBackendFormat()

GrBackendFormat::~GrBackendFormat ( )

default

Member Function Documentation

asMockColorType()

GrColorType GrBackendFormat::asMockColorType

(

)

const

If the backend API is not Mock these three calls will return kUnknown, kNone or false, respectively. Otherwise, only one of the following can be true. The GrColorType is not kUnknown, the compression type is not kNone, or this is a mock stencil format.

Definition at line 152 of file GrBackendSurface.cpp.

                                                   {
    if (this->isValid() && GrBackendApi::kMock == fBackend) {
        SkASSERT(this->validateMock());
        return fMock.fColorType;
    }
 
    return GrColorType::kUnknown;
}

asMockCompressionType()

SkTextureCompressionType GrBackendFormat::asMockCompressionType

(

)

const

Definition at line 161 of file GrBackendSurface.cpp.

                                                                      {
    if (this->isValid() && GrBackendApi::kMock == fBackend) {
        SkASSERT(this->validateMock());
        return fMock.fCompressionType;
    }
 
    return SkTextureCompressionType::kNone;
}

backend()

GrBackendApi GrBackendFormat::backend ( ) const

inline

Definition at line 65 of file GrBackendSurface.h.

{ return fBackend; }

channelMask()

uint32_t GrBackendFormat::channelMask

(

)

const

Gets the channels present in the format as a bitfield of SkColorChannelFlag values. Luminance channels are reported as kGray_SkColorChannelFlag.

Definition at line 94 of file GrBackendSurface.cpp.

                                            {
    if (!this->isValid()) {
        return 0;
    }
    switch (fBackend) {
        case GrBackendApi::kOpenGL:
        case GrBackendApi::kVulkan:
        case GrBackendApi::kMetal:
            return fFormatData->channelMask();
#ifdef SK_DIRECT3D
        case GrBackendApi::kDirect3D:
            return GrDxgiFormatChannels(fDxgiFormat);
#endif
        case GrBackendApi::kMock:
            return GrColorTypeChannelFlags(fMock.fColorType);
 
        default:
            return 0;
    }
}

desc()

GrColorFormatDesc GrBackendFormat::desc

(

)

const

Definition at line 115 of file GrBackendSurface.cpp.

                                              {
    if (!this->isValid()) {
        return GrColorFormatDesc::MakeInvalid();
    }
    switch (fBackend) {
        case GrBackendApi::kOpenGL:
        case GrBackendApi::kVulkan:
        case GrBackendApi::kMetal:
            return fFormatData->desc();
#ifdef SK_DIRECT3D
        case GrBackendApi::kDirect3D:
            return GrDxgiFormatDesc(fDxgiFormat);
#endif
        case GrBackendApi::kMock:
            return GrGetColorTypeDesc(fMock.fColorType);
 
        default:
            return GrColorFormatDesc::MakeInvalid();
    }
}

isMockStencilFormat()

bool GrBackendFormat::isMockStencilFormat

(

)

const

Definition at line 170 of file GrBackendSurface.cpp.

                                                {
    if (this->isValid() && GrBackendApi::kMock == fBackend) {
        SkASSERT(this->validateMock());
        return fMock.fIsStencilFormat;
    }
 
    return false;
}

isValid()

bool GrBackendFormat::isValid ( ) const

inline

Definition at line 99 of file GrBackendSurface.h.

{ return fValid; }

MakeMock()

GrBackendFormat GrBackendFormat::MakeMock ( GrColorType  colorType, SkTextureCompressionType  compression, bool  isStencilFormat = false  )

static

Definition at line 189 of file GrBackendSurface.cpp.

                                                                {
    return GrBackendFormat(colorType, compression, isStencilFormat);
}

makeTexture2D()

GrBackendFormat GrBackendFormat::makeTexture2D

(

)

const

Definition at line 179 of file GrBackendSurface.cpp.

                                                     {
    GrBackendFormat copy = *this;
    // TODO(b/293490566): Remove this kVulkan check once all backends are using fFormatData.
    if (fBackend==GrBackendApi::kVulkan) {
        copy.fFormatData->makeTexture2D();
    }
    copy.fTextureType = GrTextureType::k2D;
    return copy;
}

operator!=()

bool GrBackendFormat::operator!= ( const GrBackendFormat &  that ) const

inline

Definition at line 63 of file GrBackendSurface.h.

{ return !(*this == that); }

operator=()

GrBackendFormat & GrBackendFormat::operator=

(

const GrBackendFormat &

that

)

Definition at line 58 of file GrBackendSurface.cpp.

                                                                       {
    if (this != &that) {
        this->~GrBackendFormat();
        new (this) GrBackendFormat(that);
    }
    return *this;
}

operator==()

bool GrBackendFormat::operator==

(

const GrBackendFormat &

that

)

const

Definition at line 195 of file GrBackendSurface.cpp.

                                                                  {
    // Invalid GrBackendFormats are never equal to anything.
    if (!fValid || !that.fValid) {
        return false;
    }
 
    if (fBackend != that.fBackend) {
        return false;
    }
 
    switch (fBackend) {
        case GrBackendApi::kOpenGL:
        case GrBackendApi::kVulkan:
        case GrBackendApi::kMetal:
            return fFormatData->equal(that.fFormatData.get());
        case GrBackendApi::kMock:
            return fMock.fColorType == that.fMock.fColorType &&
                   fMock.fCompressionType == that.fMock.fCompressionType;
#ifdef SK_DIRECT3D
        case GrBackendApi::kDirect3D:
            return fDxgiFormat == that.fDxgiFormat;
#endif
        default:
            SK_ABORT("Unknown GrBackend");
    }
    return false;
}

textureType()

GrTextureType GrBackendFormat::textureType ( ) const

inline

Definition at line 66 of file GrBackendSurface.h.

{ return fTextureType; }

Friends And Related Function Documentation

GrBackendFormatData

friend class GrBackendFormatData

friend

Definition at line 112 of file GrBackendSurface.h.

GrBackendSurfacePriv

friend class GrBackendSurfacePriv

friend

Definition at line 111 of file GrBackendSurface.h.

Member Data Documentation

fColorType

GrColorType GrBackendFormat::fColorType

Definition at line 141 of file GrBackendSurface.h.

fCompressionType

SkTextureCompressionType GrBackendFormat::fCompressionType

Definition at line 142 of file GrBackendSurface.h.

fIsStencilFormat

bool GrBackendFormat::fIsStencilFormat

Definition at line 143 of file GrBackendSurface.h.

struct { ... } GrBackendFormat::fMock

---

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

• third_party/skia/include/gpu/GrBackendSurface.h
• third_party/skia/src/gpu/ganesh/GrBackendSurface.cpp