flutter::CompositorSoftware Class Reference

#include <compositor_software.h>

Inheritance diagram for flutter::CompositorSoftware:

Public Member Functions
	CompositorSoftware (FlutterWindowsEngine *engine)
bool	CreateBackingStore (const FlutterBackingStoreConfig &config, FlutterBackingStore *result) override
	|Compositor| More...
bool	CollectBackingStore (const FlutterBackingStore *store) override
	|Compositor| More...
bool	Present (FlutterViewId view_id, const FlutterLayer **layers, size_t layers_count) override
	|Compositor| More...
Public Member Functions inherited from flutter::Compositor
virtual	~Compositor ()=default

Detailed Description

Definition at line 16 of file compositor_software.h.

Constructor & Destructor Documentation

CompositorSoftware()

flutter::CompositorSoftware::CompositorSoftware

(

FlutterWindowsEngine *

engine

)

Definition at line 12 of file compositor_software.cc.

    : engine_(engine) {}

Member Function Documentation

CollectBackingStore()

bool flutter::CompositorSoftware::CollectBackingStore ( const FlutterBackingStore *  store )

overridevirtual

|Compositor|

Implements flutter::Compositor.

Definition at line 36 of file compositor_software.cc.

                                                                             {
  std::free(const_cast<void*>(store->software.allocation));
  return true;
}

CreateBackingStore()

bool flutter::CompositorSoftware::CreateBackingStore ( const FlutterBackingStoreConfig &  config, FlutterBackingStore *  result  )

overridevirtual

|Compositor|

Implements flutter::Compositor.

Definition at line 15 of file compositor_software.cc.

                                 {
  size_t size = config.size.width * config.size.height * 4;
  void* allocation = std::calloc(size, sizeof(uint8_t));
  if (!allocation) {
    return false;
  }
 
  result->type = kFlutterBackingStoreTypeSoftware;
  result->software.allocation = allocation;
  result->software.height = config.size.height;
  result->software.row_bytes = config.size.width * 4;
  result->software.user_data = nullptr;
  result->software.destruction_callback = [](void* user_data) {
    // Backing store destroyed in `CompositorSoftware::CollectBackingStore`, set
    // on FlutterCompositor.collect_backing_store_callback during engine start.
  };
  return true;
}

References user_data.

Present()

bool flutter::CompositorSoftware::Present ( FlutterViewId  view_id, const FlutterLayer **  layers, size_t  layers_count  )

overridevirtual

|Compositor|

Implements flutter::Compositor.

Definition at line 41 of file compositor_software.cc.

                                                      {
  FlutterWindowsView* view = engine_->view(view_id);
  if (!view) {
    return false;
  }
 
  // Clear the view if there are no layers to present.
  if (layers_count == 0) {
    return view->ClearSoftwareBitmap();
  }
 
  // TODO: Support compositing layers and platform views.
  // See: https://github.com/flutter/flutter/issues/31713
  FML_DCHECK(layers_count == 1);
  FML_DCHECK(layers[0]->offset.x == 0 && layers[0]->offset.y == 0);
  FML_DCHECK(layers[0]->type == kFlutterLayerContentTypeBackingStore);
  FML_DCHECK(layers[0]->backing_store->type ==
             kFlutterBackingStoreTypeSoftware);
 
  const auto& backing_store = layers[0]->backing_store->software;
 
  return view->PresentSoftwareBitmap(
      backing_store.allocation, backing_store.row_bytes, backing_store.height);
}

References flutter::FlutterWindowsView::ClearSoftwareBitmap(), flutter::FlutterWindowsView::PresentSoftwareBitmap(), type, and flutter::FlutterWindowsEngine::view().

---

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

• shell/platform/windows/compositor_software.h
• shell/platform/windows/compositor_software.cc