SkFrame Class Reference

#include <SkFrameHolder.h>

Inheritance diagram for SkFrame:

Public Member Functions
	SkFrame (int id)
virtual	~SkFrame ()
	SkFrame (SkFrame &&)=default
int	frameId () const
SkEncodedInfo::Alpha	reportedAlpha () const
bool	hasAlpha () const
void	setHasAlpha (bool alpha)
bool	reachedStartOfData () const
int	getRequiredFrame () const
void	setRequiredFrame (int req)
void	setXYWH (int x, int y, int width, int height)
SkIRect	frameRect () const
int	xOffset () const
int	yOffset () const
int	width () const
int	height () const
SkCodecAnimation::DisposalMethod	getDisposalMethod () const
void	setDisposalMethod (SkCodecAnimation::DisposalMethod disposalMethod)
void	setDuration (int duration)
int	getDuration () const
void	setBlend (SkCodecAnimation::Blend blend)
SkCodecAnimation::Blend	getBlend () const
void	fillIn (SkCodec::FrameInfo *, bool fullyReceived) const
Public Member Functions inherited from SkNoncopyable
	SkNoncopyable ()=default
	SkNoncopyable (SkNoncopyable &&)=default
SkNoncopyable &	operator= (SkNoncopyable &&)=default

Protected Member Functions
virtual SkEncodedInfo::Alpha	onReportedAlpha () const =0

Detailed Description

Base class for a single frame of an animated image.

Separate from SkCodec::FrameInfo, which is a pared down interface that only contains the info the client needs.

Definition at line 24 of file SkFrameHolder.h.

Constructor & Destructor Documentation

SkFrame() [1/2]

SkFrame::SkFrame ( int  id )

inline

Definition at line 26 of file SkFrameHolder.h.

        : fId(id)
        , fHasAlpha(false)
        , fRequiredFrame(kUninitialized)
        , fDisposalMethod(SkCodecAnimation::DisposalMethod::kKeep)
        , fDuration(0)
        , fBlend(SkCodecAnimation::Blend::kSrcOver)
    {
        fRect.setEmpty();
    }

~SkFrame()

virtual SkFrame::~SkFrame ( )

inlinevirtual

Definition at line 37 of file SkFrameHolder.h.

{}

SkFrame() [2/2]

SkFrame::SkFrame ( SkFrame &&  )

default

An explicit move constructor, as https://en.cppreference.com/w/cpp/language/move_constructor says that there is no implicit move constructor if there are user-declared destructors, and we have one, immediately above.

Without a move constructor, it is harder to use an SkFrame, or an SkFrame subclass, inside a std::vector.

Member Function Documentation

fillIn()

void SkFrame::fillIn	(	SkCodec::FrameInfo *	frameInfo,
		bool	fullyReceived
	)		const

Fill in the FrameInfo with details from this object.

Definition at line 908 of file SkCodec.cpp.

                                                                          {
    SkASSERT(frameInfo);
 
    frameInfo->fRequiredFrame = fRequiredFrame;
    frameInfo->fDuration = fDuration;
    frameInfo->fFullyReceived = fullyReceived;
    frameInfo->fAlphaType = fHasAlpha ? kUnpremul_SkAlphaType
                                      : kOpaque_SkAlphaType;
    frameInfo->fHasAlphaWithinBounds = this->reportedAlpha() != SkEncodedInfo::kOpaque_Alpha;
    frameInfo->fDisposalMethod = fDisposalMethod;
    frameInfo->fBlend = fBlend;
    frameInfo->fFrameRect = fRect;
}

frameId()

int SkFrame::frameId ( ) const

inline

0-based index of the frame in the image sequence.

Definition at line 53 of file SkFrameHolder.h.

{ return fId; }

frameRect()

SkIRect SkFrame::frameRect ( ) const

inline

The rectangle that is updated by this frame.

Definition at line 108 of file SkFrameHolder.h.

{ return fRect; }

getBlend()

SkCodecAnimation::Blend SkFrame::getBlend ( ) const

inline

Definition at line 141 of file SkFrameHolder.h.

                                           {
        return fBlend;
    }

getDisposalMethod()

SkCodecAnimation::DisposalMethod SkFrame::getDisposalMethod ( ) const

inline

Definition at line 115 of file SkFrameHolder.h.

                                                             {
        return fDisposalMethod;
    }

getDuration()

int SkFrame::getDuration ( ) const

inline

Duration in ms to show this frame.

Definition at line 133 of file SkFrameHolder.h.

                            {
        return fDuration;
    }

getRequiredFrame()

int SkFrame::getRequiredFrame ( ) const

inline

The frame this one depends on.

Must not be called until fRequiredFrame has been set properly.

Definition at line 88 of file SkFrameHolder.h.

                                 {
        SkASSERT(this->reachedStartOfData());
        return fRequiredFrame;
    }

hasAlpha()

bool SkFrame::hasAlpha ( ) const

inline

Cached value representing whether the frame has alpha, after compositing with the prior frame.

Definition at line 70 of file SkFrameHolder.h.

{ return fHasAlpha; }

height()

int SkFrame::height ( ) const

inline

Definition at line 113 of file SkFrameHolder.h.

{ return fRect.height(); }

onReportedAlpha()

virtual SkEncodedInfo::Alpha SkFrame::onReportedAlpha ( ) const

protectedpure virtual

Implemented in SkWuffsFrame.

reachedStartOfData()

bool SkFrame::reachedStartOfData ( ) const

inline

Whether enough of the frame has been read to determine fRequiredFrame and fHasAlpha.

Definition at line 81 of file SkFrameHolder.h.

{ return fRequiredFrame != kUninitialized; }

reportedAlpha()

SkEncodedInfo::Alpha SkFrame::reportedAlpha ( ) const

inline

How this frame reports its alpha.

This only considers the rectangle of this frame, and considers it to have alpha even if it is opaque once blended with the frame behind it.

Definition at line 62 of file SkFrameHolder.h.

                                             {
        return this->onReportedAlpha();
    }

setBlend()

void SkFrame::setBlend ( SkCodecAnimation::Blend  blend )

inline

Definition at line 137 of file SkFrameHolder.h.

                                               {
        fBlend = blend;
    }

setDisposalMethod()

void SkFrame::setDisposalMethod ( SkCodecAnimation::DisposalMethod  disposalMethod )

inline

Definition at line 119 of file SkFrameHolder.h.

                                                                          {
        fDisposalMethod = disposalMethod;
    }

setDuration()

void SkFrame::setDuration ( int  duration )

inline

Set the duration (in ms) to show this frame.

Definition at line 126 of file SkFrameHolder.h.

                                   {
        fDuration = duration;
    }

setHasAlpha()

void SkFrame::setHasAlpha ( bool  alpha )

inline

Cache whether the finished frame has alpha.

Definition at line 75 of file SkFrameHolder.h.

{ fHasAlpha = alpha; }

setRequiredFrame()

void SkFrame::setRequiredFrame ( int  req )

inline

Set the frame that this frame depends on.

Definition at line 96 of file SkFrameHolder.h.

{ fRequiredFrame = req; }

setXYWH()

void SkFrame::setXYWH ( int  x, int  y, int  width, int  height  )

inline

Set the rectangle that is updated by this frame.

Definition at line 101 of file SkFrameHolder.h.

                                                      {
        fRect.setXYWH(x, y, width, height);
    }

width()

int SkFrame::width ( ) const

inline

Definition at line 112 of file SkFrameHolder.h.

{ return fRect.width(); }

xOffset()

int SkFrame::xOffset ( ) const

inline

Definition at line 110 of file SkFrameHolder.h.

{ return fRect.x(); }

yOffset()

int SkFrame::yOffset ( ) const

inline

Definition at line 111 of file SkFrameHolder.h.

{ return fRect.y(); }

---

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

• third_party/skia/src/codec/SkFrameHolder.h
• third_party/skia/src/codec/SkCodec.cpp