flutter::ImageDecoder Class Reference

#include <image_decoder.h>

Inheritance diagram for flutter::ImageDecoder:

Classes
struct	Options

Public Types
enum	TargetPixelFormat {   kUnknown ,   kDontCare ,   kR32G32B32A32Float ,   kR32Float }
using	ImageResult = std::function< void(sk_sp< DlImage >, std::string)>

Public Member Functions
virtual	~ImageDecoder ()
virtual void	Decode (fml::RefPtr< ImageDescriptor > descriptor, const Options &options, const ImageResult &result)=0
fml::TaskRunnerAffineWeakPtr< ImageDecoder >	GetWeakPtr () const

Static Public Member Functions
static std::unique_ptr< ImageDecoder >	Make (const Settings &settings, const TaskRunners &runners, std::shared_ptr< fml::ConcurrentTaskRunner > concurrent_task_runner, const fml::WeakPtr< IOManager > &io_manager, const std::shared_ptr< fml::SyncSwitch > &gpu_disabled_switch)

Protected Member Functions
	ImageDecoder (const TaskRunners &runners, std::shared_ptr< fml::ConcurrentTaskRunner > concurrent_task_runner, fml::WeakPtr< IOManager > io_manager)

Protected Attributes
TaskRunners	runners_
std::shared_ptr< fml::ConcurrentTaskRunner >	concurrent_task_runner_
fml::WeakPtr< IOManager >	io_manager_

Detailed Description

Definition at line 24 of file image_decoder.h.

Member Typedef Documentation

ImageResult

using flutter::ImageDecoder::ImageResult = std::function<void(sk_sp<DlImage>, std::string)>

Definition at line 35 of file image_decoder.h.

Member Enumeration Documentation

TargetPixelFormat

enum flutter::ImageDecoder::TargetPixelFormat

Enumerator
kUnknown	An unknown pixel format, reserved for error cases.
kDontCare	Explicitly declare the target pixel is left for the engine to decide.
kR32G32B32A32Float
kR32Float

Definition at line 37 of file image_decoder.h.

                         {
    /// An unknown pixel format, reserved for error cases.
    kUnknown,
    /// Explicitly declare the target pixel is left for the engine to decide.
    kDontCare,
    kR32G32B32A32Float,
    kR32Float,
  };

Constructor & Destructor Documentation

~ImageDecoder()

flutter::ImageDecoder::~ImageDecoder ( )

virtualdefault

ImageDecoder()

flutter::ImageDecoder::ImageDecoder ( const TaskRunners &  runners, std::shared_ptr< fml::ConcurrentTaskRunner >  concurrent_task_runner, fml::WeakPtr< IOManager >  io_manager  )

protected

Definition at line 43 of file image_decoder.cc.

    : runners_(runners),
      concurrent_task_runner_(std::move(concurrent_task_runner)),
      io_manager_(std::move(io_manager)),
      weak_factory_(this) {
  FML_DCHECK(runners_.IsValid());
  FML_DCHECK(runners_.GetUITaskRunner()->RunsTasksOnCurrentThread())
      << "The image decoder must be created & collected on the UI thread.";
}

References FML_DCHECK, flutter::TaskRunners::GetUITaskRunner(), flutter::TaskRunners::IsValid(), runners_, and fml::TaskRunner::RunsTasksOnCurrentThread().

Member Function Documentation

Decode()

virtual void flutter::ImageDecoder::Decode ( fml::RefPtr< ImageDescriptor >  descriptor, const Options &  options, const ImageResult &  result  )

pure virtual

Implemented in flutter::ImageDecoderImpeller, and flutter::ImageDecoderSkia.

GetWeakPtr()

fml::TaskRunnerAffineWeakPtr< ImageDecoder > flutter::ImageDecoder::GetWeakPtr

(

)

const

Definition at line 58 of file image_decoder.cc.

                                                                        {
  return weak_factory_.GetWeakPtr();
}

Make()

std::unique_ptr< ImageDecoder > flutter::ImageDecoder::Make ( const Settings &  settings, const TaskRunners &  runners, std::shared_ptr< fml::ConcurrentTaskRunner >  concurrent_task_runner, const fml::WeakPtr< IOManager > &  io_manager, const std::shared_ptr< fml::SyncSwitch > &  gpu_disabled_switch  )

static

Definition at line 15 of file image_decoder.cc.

                                                             {
#if IMPELLER_SUPPORTS_RENDERING
  if (settings.enable_impeller) {
    return std::make_unique<ImageDecoderImpeller>(
        runners,                            //
        std::move(concurrent_task_runner),  //
        io_manager,                         //
        settings.enable_wide_gamut,         //
        gpu_disabled_switch);
  }
#endif  // IMPELLER_SUPPORTS_RENDERING
#if !SLIMPELLER
  return std::make_unique<ImageDecoderSkia>(
      runners,                            //
      std::move(concurrent_task_runner),  //
      io_manager                          //
  );
#else   //  !SLIMPELLER
  FML_LOG(FATAL) << "Could not setup an image decoder.";
  return nullptr;
#endif  //  !SLIMPELLER
}

References flutter::Settings::enable_impeller, flutter::Settings::enable_wide_gamut, and FML_LOG.

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

Member Data Documentation

concurrent_task_runner_

std::shared_ptr<fml::ConcurrentTaskRunner> flutter::ImageDecoder::concurrent_task_runner_

protected

Definition at line 65 of file image_decoder.h.

Referenced by flutter::ImageDecoderSkia::Decode().

io_manager_

fml::WeakPtr<IOManager> flutter::ImageDecoder::io_manager_

protected

Definition at line 66 of file image_decoder.h.

Referenced by flutter::ImageDecoderSkia::Decode().

runners_

TaskRunners flutter::ImageDecoder::runners_

protected

Definition at line 64 of file image_decoder.h.

Referenced by flutter::ImageDecoderSkia::Decode(), ImageDecoder(), and flutter::ImageDecoderImpeller::ImageDecoderImpeller().

---

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

• lib/ui/painting/image_decoder.h
• lib/ui/painting/image_decoder.cc