SkSurfaceProps Class Reference

#include <SkSurfaceProps.h>

Public Types
enum	Flags { kDefault_Flag = 0 , kUseDeviceIndependentFonts_Flag = 1 << 0 , kDynamicMSAA_Flag = 1 << 1 , kAlwaysDither_Flag = 1 << 2 }

Public Member Functions
	SkSurfaceProps ()
	SkSurfaceProps (uint32_t flags, SkPixelGeometry)
	SkSurfaceProps (uint32_t flags, SkPixelGeometry, SkScalar textContrast, SkScalar textGamma)
	SkSurfaceProps (const SkSurfaceProps &)=default
SkSurfaceProps &	operator= (const SkSurfaceProps &)=default
SkSurfaceProps	cloneWithPixelGeometry (SkPixelGeometry newPixelGeometry) const
uint32_t	flags () const
SkPixelGeometry	pixelGeometry () const
SkScalar	textContrast () const
SkScalar	textGamma () const
bool	isUseDeviceIndependentFonts () const
bool	isAlwaysDither () const
bool	operator== (const SkSurfaceProps &that) const
bool	operator!= (const SkSurfaceProps &that) const

Static Public Attributes
static constexpr SkScalar	kMaxContrastInclusive = 1
static constexpr SkScalar	kMinContrastInclusive = 0
static constexpr SkScalar	kMaxGammaExclusive = 4
static constexpr SkScalar	kMinGammaInclusive = 0

Detailed Description

Describes properties and constraints of a given SkSurface. The rendering engine can parse these during drawing, and can sometimes optimize its performance (e.g. disabling an expensive feature).

Definition at line 53 of file SkSurfaceProps.h.

Member Enumeration Documentation

Flags

enum SkSurfaceProps::Flags

Enumerator
kDefault_Flag
kUseDeviceIndependentFonts_Flag
kDynamicMSAA_Flag
kAlwaysDither_Flag

Definition at line 55 of file SkSurfaceProps.h.

               {
        kDefault_Flag = 0,
        kUseDeviceIndependentFonts_Flag = 1 << 0,
        // Use internal MSAA to render to non-MSAA GPU surfaces.
        kDynamicMSAA_Flag = 1 << 1,
        // If set, all rendering will have dithering enabled
        // Currently this only impacts GPU backends
        kAlwaysDither_Flag = 1 << 2,
    };

Constructor & Destructor Documentation

SkSurfaceProps() [1/4]

SkSurfaceProps::SkSurfaceProps

(

)

No flags, unknown pixel geometry, platform-default contrast/gamma.

Definition at line 37 of file SkSurface.cpp.

    : fFlags(0)
    , fPixelGeometry(kUnknown_SkPixelGeometry)
    , fTextContrast(SK_GAMMA_CONTRAST)
    , fTextGamma(SK_GAMMA_EXPONENT) {}

SkSurfaceProps() [2/4]

SkSurfaceProps::SkSurfaceProps	(	uint32_t	flags,
		SkPixelGeometry	pg
	)

TODO(kschmi): Remove this constructor and replace with the one below.

Definition at line 43 of file SkSurface.cpp.

    : fFlags(flags)
    , fPixelGeometry(pg)
    , fTextContrast(SK_GAMMA_CONTRAST)
    , fTextGamma(SK_GAMMA_EXPONENT) {}

SkSurfaceProps() [3/4]

SkSurfaceProps::SkSurfaceProps	(	uint32_t	flags,
		SkPixelGeometry	pg,
		SkScalar	textContrast,
		SkScalar	textGamma
	)

Specified pixel geometry, text contrast, and gamma

Definition at line 49 of file SkSurface.cpp.

    : fFlags(flags), fPixelGeometry(pg), fTextContrast(textContrast), fTextGamma(textGamma) {}

SkSurfaceProps() [4/4]

SkSurfaceProps::SkSurfaceProps ( const SkSurfaceProps &  )

default

Member Function Documentation

cloneWithPixelGeometry()

SkSurfaceProps SkSurfaceProps::cloneWithPixelGeometry ( SkPixelGeometry  newPixelGeometry ) const

inline

Definition at line 75 of file SkSurfaceProps.h.

                                                                                  {
        return SkSurfaceProps(fFlags, newPixelGeometry, fTextContrast, fTextGamma);
    }

flags()

uint32_t SkSurfaceProps::flags ( ) const

inline

Definition at line 84 of file SkSurfaceProps.h.

{ return fFlags; }

isAlwaysDither()

bool SkSurfaceProps::isAlwaysDither ( ) const

inline

Definition at line 93 of file SkSurfaceProps.h.

                                {
        return SkToBool(fFlags & kAlwaysDither_Flag);
    }

isUseDeviceIndependentFonts()

bool SkSurfaceProps::isUseDeviceIndependentFonts ( ) const

inline

Definition at line 89 of file SkSurfaceProps.h.

                                             {
        return SkToBool(fFlags & kUseDeviceIndependentFonts_Flag);
    }

operator!=()

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

inline

Definition at line 102 of file SkSurfaceProps.h.

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

operator=()

SkSurfaceProps & SkSurfaceProps::operator= ( const SkSurfaceProps &  )

default

operator==()

bool SkSurfaceProps::operator== ( const SkSurfaceProps &  that ) const

inline

Definition at line 97 of file SkSurfaceProps.h.

                                                      {
        return fFlags == that.fFlags && fPixelGeometry == that.fPixelGeometry &&
        fTextContrast == that.fTextContrast && fTextGamma == that.fTextGamma;
    }

pixelGeometry()

SkPixelGeometry SkSurfaceProps::pixelGeometry ( ) const

inline

Definition at line 85 of file SkSurfaceProps.h.

{ return fPixelGeometry; }

textContrast()

SkScalar SkSurfaceProps::textContrast ( ) const

inline

Definition at line 86 of file SkSurfaceProps.h.

{ return fTextContrast; }

textGamma()

SkScalar SkSurfaceProps::textGamma ( ) const

inline

Definition at line 87 of file SkSurfaceProps.h.

{ return fTextGamma; }

Member Data Documentation

kMaxContrastInclusive

constexpr SkScalar SkSurfaceProps::kMaxContrastInclusive = 1

staticconstexpr

Definition at line 79 of file SkSurfaceProps.h.

kMaxGammaExclusive

constexpr SkScalar SkSurfaceProps::kMaxGammaExclusive = 4

staticconstexpr

Definition at line 81 of file SkSurfaceProps.h.

kMinContrastInclusive

constexpr SkScalar SkSurfaceProps::kMinContrastInclusive = 0

staticconstexpr

Definition at line 80 of file SkSurfaceProps.h.

kMinGammaInclusive

constexpr SkScalar SkSurfaceProps::kMinGammaInclusive = 0

staticconstexpr

Definition at line 82 of file SkSurfaceProps.h.

---

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

• third_party/skia/include/core/SkSurfaceProps.h
• third_party/skia/src/image/SkSurface.cpp