SkPixelRef Class Reference

#include <SkPixelRef.h>

Inheritance diagram for SkPixelRef:

Public Member Functions
	SkPixelRef (int width, int height, void *addr, size_t rowBytes)
	~SkPixelRef () override
SkISize	dimensions () const
int	width () const
int	height () const
void *	pixels () const
size_t	rowBytes () const
uint32_t	getGenerationID () const
void	notifyPixelsChanged ()
bool	isImmutable () const
void	setImmutable ()
void	addGenIDChangeListener (sk_sp< SkIDChangeListener > listener)
void	notifyAddedToCache ()
virtual SkDiscardableMemory *	diagnostic_only_getDiscardable () const
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Protected Member Functions
void	android_only_reset (int width, int height, size_t rowBytes)

Friends
class	SkSurface_Raster
void	SkBitmapCache_setImmutableWithID (SkPixelRef *, uint32_t)

Detailed Description

This class is the smart container for pixel memory, and is used with SkBitmap. This class can be shared/accessed between multiple threads.

Definition at line 28 of file SkPixelRef.h.

Constructor & Destructor Documentation

SkPixelRef()

SkPixelRef::SkPixelRef	(	int	width,
		int	height,
		void *	addr,
		size_t	rowBytes
	)

Definition at line 32 of file SkPixelRef.cpp.

    : fWidth(width)
    , fHeight(height)
    , fPixels(pixels)
    , fRowBytes(rowBytes)
    , fAddedToCache(false)
{
    this->needsNewGenID();
    fMutability = kMutable;
}

~SkPixelRef()

SkPixelRef::~SkPixelRef ( )

override

Definition at line 43 of file SkPixelRef.cpp.

                        {
    this->callGenIDChangeListeners();
}

Member Function Documentation

addGenIDChangeListener()

void SkPixelRef::addGenIDChangeListener

(

sk_sp< SkIDChangeListener >

listener

)

Definition at line 78 of file SkPixelRef.cpp.

                                                                          {
    if (!listener || !this->genIDIsUnique()) {
        // No point in tracking this if we're not going to call it.
        return;
    }
    SkASSERT(!listener->shouldDeregister());
    fGenIDChangeListeners.add(std::move(listener));
}

android_only_reset()

void SkPixelRef::android_only_reset ( int  width, int  height, size_t  rowBytes  )

protected

Definition at line 48 of file SkPixelRef.cpp.

                                                                          {
    fWidth = width;
    fHeight = height;
    fRowBytes = rowBytes;
    // note: we do not change fPixels
 
    // conservative, since its possible the "new" settings are the same as the old.
    this->notifyPixelsChanged();
}

diagnostic_only_getDiscardable()

virtual SkDiscardableMemory * SkPixelRef::diagnostic_only_getDiscardable ( ) const

inlinevirtual

Definition at line 80 of file SkPixelRef.h.

{ return nullptr; }

dimensions()

SkISize SkPixelRef::dimensions ( ) const

inline

Definition at line 33 of file SkPixelRef.h.

{ return {fWidth, fHeight}; }

getGenerationID()

uint32_t SkPixelRef::getGenerationID

(

)

const

Returns a non-zero, unique value corresponding to the pixels in this pixelref. Each time the pixels are changed (and notifyPixelsChanged is called), a different generation ID will be returned.

Definition at line 63 of file SkPixelRef.cpp.

                                           {
    uint32_t id = fTaggedGenID.load();
    if (0 == id) {
        uint32_t next = SkNextID::ImageID() | 1u;
        if (fTaggedGenID.compare_exchange_strong(id, next)) {
            id = next;  // There was no race or we won the race.  fTaggedGenID is next now.
        } else {
            // We lost a race to set fTaggedGenID. compare_exchange() filled id with the winner.
        }
        // We can't quite SkASSERT(this->genIDIsUnique()). It could be non-unique
        // if we got here via the else path (pretty unlikely, but possible).
    }
    return id & ~1u;  // Mask off bottom unique bit.
}

height()

int SkPixelRef::height ( ) const

inline

Definition at line 35 of file SkPixelRef.h.

{ return fHeight; }

isImmutable()

bool SkPixelRef::isImmutable ( ) const

inline

Returns true if this pixelref is marked as immutable, meaning that the contents of its pixels will not change for the lifetime of the pixelref.

Definition at line 55 of file SkPixelRef.h.

{ return fMutability != kMutable; }

notifyAddedToCache()

void SkPixelRef::notifyAddedToCache ( )

inline

Definition at line 76 of file SkPixelRef.h.

                              {
        fAddedToCache.store(true);
    }

notifyPixelsChanged()

void SkPixelRef::notifyPixelsChanged

(

)

Call this if you have changed the contents of the pixels. This will in- turn cause a different generation ID value to be returned from getGenerationID().

Definition at line 102 of file SkPixelRef.cpp.

                                     {
#ifdef SK_DEBUG
    if (this->isImmutable()) {
        SkDebugf("========== notifyPixelsChanged called on immutable pixelref");
    }
#endif
    this->callGenIDChangeListeners();
    this->needsNewGenID();
}

pixels()

void * SkPixelRef::pixels ( ) const

inline

Definition at line 36 of file SkPixelRef.h.

{ return fPixels; }

rowBytes()

size_t SkPixelRef::rowBytes ( ) const

inline

Definition at line 37 of file SkPixelRef.h.

{ return fRowBytes; }

setImmutable()

void SkPixelRef::setImmutable

(

)

Marks this pixelref is immutable, meaning that the contents of its pixels will not change for the lifetime of the pixelref. This state can be set on a pixelref, but it cannot be cleared once it is set.

Definition at line 112 of file SkPixelRef.cpp.

                              {
    fMutability = kImmutable;
}

width()

int SkPixelRef::width ( ) const

inline

Definition at line 34 of file SkPixelRef.h.

{ return fWidth; }

Friends And Related Function Documentation

SkBitmapCache_setImmutableWithID

void SkBitmapCache_setImmutableWithID ( SkPixelRef *  pr, uint32_t  id  )

friend

Definition at line 70 of file SkBitmapCache.cpp.

                                                                   {
    pr->setImmutableWithID(id);
}

SkSurface_Raster

friend class SkSurface_Raster

friend

Definition at line 111 of file SkPixelRef.h.

---

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

• third_party/skia/include/core/SkPixelRef.h
• third_party/skia/src/core/SkPixelRef.cpp