SkPngEncoder Namespace Reference

Classes
struct	Options

Enumerations
enum class	FilterFlag : int {   kZero = 0x00 , kNone = 0x08 , kSub = 0x10 , kUp = 0x20 ,   kAvg = 0x40 , kPaeth = 0x80 , kAll = kNone | kSub | kUp | kAvg | kPaeth }

Functions
FilterFlag	operator| (FilterFlag x, FilterFlag y)
SK_API bool	Encode (SkWStream *dst, const SkPixmap &src, const Options &options)
SK_API sk_sp< SkData >	Encode (GrDirectContext *ctx, const SkImage *img, const Options &options)
SK_API std::unique_ptr< SkEncoder >	Make (SkWStream *dst, const SkPixmap &src, const Options &options)

Enumeration Type Documentation

FilterFlag

enum class SkPngEncoder::FilterFlag : int

strong

Enumerator
kZero
kNone
kSub
kUp
kAvg
kPaeth
kAll

Definition at line 29 of file SkPngEncoder.h.

                      : int {
    kZero = 0x00,
    kNone = 0x08,
    kSub = 0x10,
    kUp = 0x20,
    kAvg = 0x40,
    kPaeth = 0x80,
    kAll = kNone | kSub | kUp | kAvg | kPaeth,
};

Function Documentation

Encode() [1/2]

sk_sp< SkData > SkPngEncoder::Encode	(	GrDirectContext *	ctx,
		const SkImage *	img,
		const Options &	options
	)

Encode the provided image and return the resulting bytes. If the image was created as a texture-backed image on a GPU context, that |ctx| must be provided so the pixels can be read before being encoded. For raster-backed images, |ctx| can be nullptr. |options| may be used to control the encoding behavior.

Returns nullptr if the pixels could not be read or encoding otherwise fails.

Definition at line 25 of file SkPngEncoder_none.cpp.

                                                                       {
    SkDEBUGFAIL("Using encoder stub");
    return nullptr;
}

Encode() [2/2]

bool SkPngEncoder::Encode	(	SkWStream *	dst,
		const SkPixmap &	src,
		const Options &	options
	)

Encode the |src| pixels to the |dst| stream. |options| may be used to control the encoding behavior.

Returns true on success. Returns false on an invalid or unsupported |src|.

Definition at line 20 of file SkPngEncoder_none.cpp.

                                                         {
    SkDEBUGFAIL("Using encoder stub");
    return false;
}

Make()

std::unique_ptr< SkEncoder > SkPngEncoder::Make	(	SkWStream *	dst,
		const SkPixmap &	src,
		const Options &	options
	)

Create a png encoder that will encode the |src| pixels to the |dst| stream. |options| may be used to control the encoding behavior.

The primary use of this is incremental encoding of the pixels.

|dst| is unowned but must remain valid for the lifetime of the object.

This returns nullptr on an invalid or unsupported |src|.

Definition at line 471 of file SkPngEncoderImpl.cpp.

                                                                                           {
    if (!SkPixmapIsValid(src)) {
        return nullptr;
    }
 
    std::unique_ptr<SkPngEncoderMgr> encoderMgr = SkPngEncoderMgr::Make(dst);
    if (!encoderMgr) {
        return nullptr;
    }
 
    if (!encoderMgr->setHeader(src.info(), options)) {
        return nullptr;
    }
 
    if (!encoderMgr->setColorSpace(src.info(), options)) {
        return nullptr;
    }
 
    if (!encoderMgr->writeInfo(src.info())) {
        return nullptr;
    }
 
    encoderMgr->chooseProc(src.info());
 
    return std::make_unique<SkPngEncoderImpl>(std::move(encoderMgr), src);
}

operator|()

FilterFlag SkPngEncoder::operator| ( FilterFlag  x, FilterFlag  y  )

inline

Definition at line 39 of file SkPngEncoder.h.

{ return (FilterFlag)((int)x | (int)y); }