SkCodecs Namespace Reference

Classes
struct	Decoder

Typedefs
using	DecodeContext = void *
using	IsFormatCallback = bool(*)(const void *data, size_t len)
using	MakeFromStreamCallback = std::unique_ptr< SkCodec >(*)(std::unique_ptr< SkStream >, SkCodec::Result *, DecodeContext)

Functions
void SK_API	Register (Decoder d)
SK_API sk_sp< SkImage >	DeferredImage (std::unique_ptr< SkCodec > codec, std::optional< SkAlphaType > alphaType=std::nullopt)
static std::vector< Decoder > *	get_decoders_for_editing ()
const std::vector< Decoder > &	get_decoders ()
bool	HasDecoder (std::string_view id)

Typedef Documentation

DecodeContext

using SkCodecs::DecodeContext = typedef void*

Definition at line 1047 of file SkCodec.h.

IsFormatCallback

using SkCodecs::IsFormatCallback = typedef bool (*)(const void* data, size_t len)

Definition at line 1048 of file SkCodec.h.

MakeFromStreamCallback

using SkCodecs::MakeFromStreamCallback = typedef std::unique_ptr<SkCodec> (*)(std::unique_ptr<SkStream>, SkCodec::Result*, DecodeContext)

Definition at line 1049 of file SkCodec.h.

Function Documentation

DeferredImage()

sk_sp< SkImage > SkCodecs::DeferredImage	(	std::unique_ptr< SkCodec >	codec,
		std::optional< SkAlphaType >	alphaType = std::nullopt
	)

Return a SkImage produced by the codec, but attempts to defer image allocation until the image is actually used/drawn. This deferral allows the system to cache the result, either on the CPU or on the GPU, depending on where the image is drawn. If memory is low, the cache may be purged, causing the next draw of the image to have to re-decode.

If alphaType is nullopt, the image's alpha type will be chosen automatically based on the image format. Transparent images will default to kPremul_SkAlphaType. If alphaType contains kPremul_SkAlphaType or kUnpremul_SkAlphaType, that alpha type will be used. Forcing opaque (passing kOpaque_SkAlphaType) is not allowed, and will return nullptr.

Parameters

codec

A non-null codec (e.g. from SkPngDecoder::Decode)

Returns

created SkImage, or nullptr

Definition at line 64 of file SkImageGenerator_FromEncoded.cpp.

                                                                                               {
    return SkImages::DeferredFromGenerator(
            SkCodecImageGenerator::MakeFromCodec(std::move(codec), alphaType));
}

get_decoders()

const std::vector< Decoder > & SkCodecs::get_decoders

(

)

Definition at line 130 of file SkCodec.cpp.

                                         {
    auto decoders = get_decoders_for_editing();
    return *decoders;
}

get_decoders_for_editing()

static std::vector< Decoder > * SkCodecs::get_decoders_for_editing ( )

static

Definition at line 85 of file SkCodec.cpp.

                                                      {
    static SkNoDestructor<std::vector<Decoder>> decoders;
#if !defined(SK_DISABLE_LEGACY_INIT_DECODERS)
    static SkOnce once;
    once([] {
        if (decoders->empty()) {
#if defined(SK_CODEC_DECODES_PNG)
            decoders->push_back(SkPngDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_JPEG)
            decoders->push_back(SkJpegDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_WEBP)
            decoders->push_back(SkWebpDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_GIF) || defined(SK_HAS_WUFFS_LIBRARY)
            decoders->push_back(SkGifDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_ICO)
            decoders->push_back(SkIcoDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_BMP)
            decoders->push_back(SkBmpDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_WBMP)
            decoders->push_back(SkWbmpDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_AVIF)
            decoders->push_back(SkAvifDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_JPEGXL)
            decoders->push_back(SkJpegxlDecoder::Decoder());
#endif
#if defined(SK_HAS_HEIF_LIBRARY)
            decoders->push_back(SkHeifDecoder::Decoder());
#endif
#if defined(SK_CODEC_DECODES_RAW)
            decoders->push_back(SkRawDecoder::Decoder());
#endif
        }
    });
#endif // !defined(SK_DISABLE_LEGACY_INIT_DECODERS)
    return decoders.get();
}

HasDecoder()

bool SkCodecs::HasDecoder

(

std::string_view

id

)

Definition at line 146 of file SkCodec.cpp.

                                   {
    for (const SkCodecs::Decoder& decoder : get_decoders()) {
        if (decoder.id == id) {
            return true;
        }
    }
    return false;
}

Register()

void SkCodecs::Register

(

Decoder

d

)

Definition at line 135 of file SkCodec.cpp.

                         {
    auto decoders = get_decoders_for_editing();
    for (size_t i = 0; i < decoders->size(); i++) {
        if ((*decoders)[i].id == d.id) {
            (*decoders)[i] = d;
            return;
        }
    }
    decoders->push_back(d);
}