class Flatland
Defined at line 47 of file ../../src/ui/scenic/lib/flatland/flatland.h
Implements the `fuchsia.ui.composition.Flatland` protocol. It is intended to run on its own
thread/dispatcher, and communicates with the main/render thread(s) via the UberStruct mechanism,
as well as other interfaces such as FlatlandPresenter. Because `fuchsia.ui.composition.Flatland`
is a stateful protocol, each client is connected to a different Flatland object.
Public Methods
void Flatland (const Flatland & )Because this object captures its "this" pointer in internal closures, it is unsafe to copy or
move it. Disable all copy and move operations.
Defined at line 88 of file ../../src/ui/scenic/lib/flatland/flatland.h
Flatland & operator= (const Flatland & )Defined at line 89 of file ../../src/ui/scenic/lib/flatland/flatland.h
void Flatland (Flatland && )Defined at line 90 of file ../../src/ui/scenic/lib/flatland/flatland.h
Flatland & operator= (Flatland && )Defined at line 91 of file ../../src/ui/scenic/lib/flatland/flatland.h
std::shared_ptr<Flatland> New (std::shared_ptr<utils::DispatcherHolder> dispatcher_holder, fidl::ServerEnd<fuchsia_ui_composition::Flatland> server_end, scheduling::SessionId session_id, std::function<void ()> destroy_instance_function, std::shared_ptr<FlatlandPresenter> flatland_presenter, std::shared_ptr<LinkSystem> link_system, std::shared_ptr<UberStructSystem::UberStructQueue> uber_struct_queue, const std::vector<std::shared_ptr<allocation::BufferCollectionImporter>> & buffer_collection_importers, fit::function<void (fidl::ServerEnd<fuchsia_ui_views::Focuser>, zx_koid_t)> register_view_focuser, fit::function<void (fidl::ServerEnd<fuchsia_ui_views::ViewRefFocused>, zx_koid_t)> register_view_ref_focused, fit::function<void (fidl::ServerEnd<fuchsia_ui_pointer::TouchSource>, zx_koid_t)> register_touch_source, fit::function<void (fidl::ServerEnd<fuchsia_ui_pointer::MouseSource>, zx_koid_t)> register_mouse_source, std::optional<fuchsia_ui_composition::TrustedFlatlandConfig> config)Instantiates a new Flatland object and binds it to serve the Flatland protocol over the
`server_end` channel. Method invocations received on this channel will be serviced on
the thread managed by `dispatcher_holder`.
The `destroy_instance_function` is called to notify the instance's manager that the instance
should be destroyed. This function is invoked on the thread owned by `dispatcher_holder`. When
this function is invoked, the client FIDL connection has already been closed. There are two
situations that result in the invocation of `destroy_instance_function`:
- the client closes the FIDL channel
- the client makes illegal use of the API (or associated APIs like ChildViewWatcher)
`flatland_presenter`, `link_system`, `uber_struct_queue`, and `buffer_collection_importers`
allow this Flatland object to access resources shared by all Flatland instances for actions
like frame scheduling, linking, buffer allocation, and presentation to the global scene graph.
Defined at line 105 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReplaceChildren (TransformId parent_transform_id, std::initializer_list<TransformId> new_child_transform_ids)Defined at line 161 of file ../../src/ui/scenic/lib/flatland/flatland.h
void ~Flatland ()Defined at line 257 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void Present (PresentRequest & request, PresentCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 307 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void Present (fuchsia_ui_composition::PresentArgs args)Defined at line 311 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateView (CreateViewRequest & request, CreateViewCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 578 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateView (fuchsia_ui_views::ViewCreationToken token, fidl::ServerEnd<fuchsia_ui_composition::ParentViewportWatcher> parent_viewport_watcher)Defined at line 583 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateView2 (CreateView2Request & request, CreateView2Completer::Sync & completer)Defined at line 590 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateView2 (fuchsia_ui_views::ViewCreationToken token, fuchsia_ui_views::ViewIdentityOnCreation view_identity, fuchsia_ui_composition::ViewBoundProtocols protocols, fidl::ServerEnd<fuchsia_ui_composition::ParentViewportWatcher> parent_viewport_watcher)Defined at line 596 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseView (ReleaseViewCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
TODO(https://fxbug.dev/42162046): Consider returning tokens for re-linking.
Defined at line 709 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseView ()Defined at line 711 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void Clear (ClearCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 740 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void Clear ()Defined at line 742 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateTransform (CreateTransformRequest & request, CreateTransformCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 772 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateTransform (TransformId transform_id)Defined at line 777 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetTranslation (SetTranslationRequest & request, SetTranslationCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 797 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetTranslation (TransformId transform_id, fuchsia_math::Vec translation)Defined at line 802 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetOrientation (SetOrientationRequest & request, SetOrientationCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 824 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetOrientation (TransformId transform_id, fuchsia_ui_composition::Orientation orientation)Defined at line 829 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetScale (SetScaleRequest & request, SetScaleCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 852 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetScale (TransformId transform_id, fuchsia_math::VecF scale)Defined at line 856 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetOpacity (SetOpacityRequest & request, SetOpacityCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 894 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetOpacity (TransformId transform_id, float value)Defined at line 898 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetClipBoundary (SetClipBoundaryRequest & request, SetClipBoundaryCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 936 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetClipBoundary (TransformId transform_id, fidl::Box<fuchsia_math::Rect> bounds)Defined at line 941 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void AddChild (AddChildRequest & request, AddChildCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1015 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void AddChild (TransformId parent_transform_id, TransformId child_transform_id)Defined at line 1019 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void RemoveChild (RemoveChildRequest & request, RemoveChildCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1053 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void RemoveChild (TransformId parent_transform_id, TransformId child_transform_id)Defined at line 1058 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReplaceChildren (ReplaceChildrenRequest & request, ReplaceChildrenCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1094 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReplaceChildren (TransformId parent_transform_id, std::span<const TransformId> new_child_transform_ids)Defined at line 1110 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetRootTransform (SetRootTransformRequest & request, SetRootTransformCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1169 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetRootTransform (TransformId transform_id)Defined at line 1174 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateViewport (CreateViewportRequest & request, CreateViewportCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1201 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateViewport (ContentId viewport_id, fuchsia_ui_views::ViewportCreationToken token, fuchsia_ui_composition::ViewportProperties properties, fidl::ServerEnd<fuchsia_ui_composition::ChildViewWatcher> child_view_watcher)Defined at line 1209 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateImage (CreateImageRequest & request, CreateImageCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1301 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateImage (ContentId image_id, fuchsia_ui_composition::BufferCollectionImportToken import_token, uint32_t vmo_index, fuchsia_ui_composition::ImageProperties properties)Defined at line 1308 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageSampleRegion (SetImageSampleRegionRequest & request, SetImageSampleRegionCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1402 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageSampleRegion (ContentId image_id, types::RectangleF rect)Defined at line 1407 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageDestinationSize (SetImageDestinationSizeRequest & request, SetImageDestinationSizeCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1461 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageDestinationSize (ContentId image_id, fuchsia_math::SizeU size)Defined at line 1466 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageBlendingFunction (SetImageBlendingFunctionRequest & request, SetImageBlendingFunctionCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1493 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageBlendMode (SetImageBlendModeRequest & request, SetImageBlendModeCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1498 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageBlendMode (ContentId image_id, BlendMode blend_mode)Defined at line 1503 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageFlip (SetImageFlipRequest & request, SetImageFlipCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1527 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageFlip (ContentId image_id, fuchsia_ui_composition::ImageFlip flip)Defined at line 1531 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateFilledRect (CreateFilledRectRequest & request, CreateFilledRectCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1555 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void CreateFilledRect (ContentId rect_id)Defined at line 1560 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetSolidFill (SetSolidFillRequest & request, SetSolidFillCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1590 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetSolidFill (ContentId rect_id, fuchsia_ui_composition::ColorRgba color, fuchsia_math::SizeU size)Defined at line 1594 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseFilledRect (ReleaseFilledRectRequest & request, ReleaseFilledRectCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1641 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseFilledRect (ContentId rect_id)Defined at line 1646 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageOpacity (SetImageOpacityRequest & request, SetImageOpacityCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1678 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetImageOpacity (ContentId image_id, float opacity)Defined at line 1683 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetHitRegions (SetHitRegionsRequest & request, SetHitRegionsCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1721 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetHitRegions (TransformId transform_id, std::vector<fuchsia_ui_composition::HitRegion> regions)Defined at line 1726 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetInfiniteHitRegion (SetInfiniteHitRegionRequest & request, SetInfiniteHitRegionCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1764 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetInfiniteHitRegion (TransformId transform_id, fuchsia_ui_composition::HitTestInteraction hit_test)Defined at line 1769 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetContent (SetContentRequest & request, SetContentCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1789 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetContent (TransformId transform_id, ContentId content_id)Defined at line 1793 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetViewportProperties (SetViewportPropertiesRequest & request, SetViewportPropertiesCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1833 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetViewportProperties (ContentId viewport_id, fuchsia_ui_composition::ViewportProperties properties)Defined at line 1838 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseTransform (ReleaseTransformRequest & request, ReleaseTransformCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1895 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseTransform (TransformId transform_id)Defined at line 1900 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseViewport (ReleaseViewportRequest & request, ReleaseViewportCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1921 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseViewport (ContentId viewport_id, fit::function<void (fuchsia_ui_views::ViewportCreationToken)> completer)Defined at line 1930 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseImage (ReleaseImageRequest & request, ReleaseImageCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 1994 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseImage (ContentId image_id)Defined at line 1998 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetDebugName (SetDebugNameRequest & request, SetDebugNameCompleter::Sync & completer)|fuchsia_ui_composition::Flatland|
Defined at line 2034 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetDebugName (std::string name)Defined at line 2043 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseImageImmediately (ReleaseImageImmediatelyRequest & request, ReleaseImageImmediatelyCompleter::Sync & completer)|fuchsia_ui_composition::TrustedFlatland|
Defined at line 2054 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void ReleaseImageImmediately (ContentId image_id)Defined at line 2059 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void OnNextFrameBegin (uint32_t additional_present_credits, FuturePresentationInfos presentation_infos)Called just before the FIDL client receives the event of the same name, indicating that this
Flatland instance should allow a |additional_present_credits| calls to Present().
Defined at line 2106 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void OnFramePresented (const std::map<scheduling::PresentId, zx::time> & latched_times, scheduling::PresentTimestamps present_times)Called when this Flatland instance should send the OnFramePresented() event to the FIDL
client.
Defined at line 2128 of file ../../src/ui/scenic/lib/flatland/flatland.cc
TransformHandle GetRoot ()For validating the transform hierarchy in tests only. For the sake of testing, the "root" will
always be the top-most TransformHandle from the TransformGraph owned by this Flatland. If
currently linked to a parent, that means the Link's child_transform_handle. If not, that means
the local_root_.
Defined at line 2156 of file ../../src/ui/scenic/lib/flatland/flatland.cc
std::optional<TransformHandle> GetContentHandle (ContentId content_id)For validating properties associated with content in tests only. If |content_id| does not
exist for this Flatland instance, returns std::nullopt.
Defined at line 2160 of file ../../src/ui/scenic/lib/flatland/flatland.cc
std::optional<TransformHandle> GetTransformHandle (TransformId transform_id)For validating properties associated with transforms in tests only. If |transform_id| does not
exist for this Flatland instance, returns std::nullopt.
Defined at line 2170 of file ../../src/ui/scenic/lib/flatland/flatland.cc
void SetErrorReporter (std::unique_ptr<scenic_impl::ErrorReporter> error_reporter)For validating logs in tests only.
Defined at line 2178 of file ../../src/ui/scenic/lib/flatland/flatland.cc
scheduling::SessionId GetSessionId ()For using as a unique identifier in tests only.
Defined at line 2182 of file ../../src/ui/scenic/lib/flatland/flatland.cc