skresources::ImageAsset Class Reference

#include <SkResources.h>

Inheritance diagram for skresources::ImageAsset:

Classes
struct	FrameData

Public Types
enum class	SizeFit {   kFill = SkMatrix::kFill_ScaleToFit , kStart = SkMatrix::kStart_ScaleToFit , kCenter = SkMatrix::kCenter_ScaleToFit , kEnd = SkMatrix::kEnd_ScaleToFit ,   kNone }

Public Member Functions
virtual bool	isMultiFrame ()=0
virtual sk_sp< SkImage >	getFrame (float t)
virtual FrameData	getFrameData (float t)
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Detailed Description

Image asset proxy interface.

Definition at line 32 of file SkResources.h.

Member Enumeration Documentation

SizeFit

enum class skresources::ImageAsset::SizeFit

strong

Enumerator
kFill
kStart
kCenter
kEnd
kNone

Definition at line 55 of file SkResources.h.

                       {
        // See SkMatrix::ScaleToFit
        kFill   = SkMatrix::kFill_ScaleToFit,
        kStart  = SkMatrix::kStart_ScaleToFit,
        kCenter = SkMatrix::kCenter_ScaleToFit,
        kEnd    = SkMatrix::kEnd_ScaleToFit,
 
        // No scaling.
        kNone,
    };

Member Function Documentation

getFrame()

sk_sp< SkImage > skresources::ImageAsset::getFrame ( float  t )

virtual

DEPRECATED: override getFrameData() instead.

Returns the SkImage for a given frame.

If the image asset is static, getFrame() is only called once, at animation load time. Otherwise, this gets invoked every time the animation time is adjusted (on every seek).

Embedders should cache and serve the same SkImage whenever possible, for efficiency.

Parameters

t	Frame time code, in seconds, relative to the image layer timeline origin (in-point).

Reimplemented in skresources::MultiFrameImageAsset.

Definition at line 96 of file SkResources.cpp.

                                           {
    return nullptr;
}

getFrameData()

ImageAsset::FrameData skresources::ImageAsset::getFrameData ( float  t )

virtual

Returns the payload for a given frame.

If the image asset is static, getFrameData() is only called once, at animation load time. Otherwise, this gets invoked every time the animation time is adjusted (on every seek).

Embedders should cache and serve the same SkImage whenever possible, for efficiency.

Parameters

t	Frame time code, in seconds, relative to the image layer timeline origin (in-point).

Reimplemented in skottie::SlotManager::ImageAssetProxy.

Definition at line 100 of file SkResources.cpp.

                                                    {
    // legacy behavior
    return {
        this->getFrame(t),
        SkSamplingOptions(SkFilterMode::kLinear, SkMipmapMode::kNearest),
        SkMatrix::I(),
        SizeFit::kCenter,
    };
}

isMultiFrame()

virtual bool skresources::ImageAsset::isMultiFrame ( )

pure virtual

Returns true if the image asset is animated.

Implemented in skottie::SlotManager::ImageAssetProxy, and skresources::MultiFrameImageAsset.

---

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

• third_party/skia/modules/skresources/include/SkResources.h
• third_party/skia/modules/skresources/src/SkResources.cpp