Namespaces

Enumerations

enum class RegisterBufferCollectionError : uint32_t
Name Value
kBadOperation 1u

The set of error codes returned by Allocator::RegisterBufferCollection().

Defined at line 125 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class RegisterBufferCollectionUsage : uint32_t
Name Value Comments
kDefault 0u

DEFAULT means that the specified buffer collection will be used for
Flatland and gfx image creation.

See [`fuchsia.ui.composition/Flatland.CreateImage`] for more.

kScreenshot 1u

SCREENSHOT means that the specified buffer collection will be used for
screenshotting purposes.

The possible usages for registered buffer collection.

Defined at line 147 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class FlatlandError : uint32_t
Name Value Comments
kBadOperation 1u

Indicates that the parameters used the function calls are invalid.

kNoPresentsRemaining 2u

Indicates that `additional_present_credits` field was not properly processed and the client
queued more [`Present`]s than allowed.

kBadHangingGet 3u

Indicates that the client has overwritten hanging gets in the protocols returned.

The set of error codes returned in [`OnError`]. Everything except NO_ERROR, causes Flatland

channel to be closed.

Defined at line 178 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class Orientation : uint32_t
Name Value
kCcw0Degrees 1u
kCcw90Degrees 2u
kCcw180Degrees 3u
kCcw270Degrees 4u

In Flatland, the +X axis is to the right and +Y axis is down. There is no notion of a Z axis.

Due to the lack of a Z axis, there is no mathematical notion of "handedness" (either right or

left) with respect to rotation. Thus, we define a counter-clockwise rotation in the same way

as if a skeuomorphic clock were to be displayed on the screen, with the hands of said clock

moving in a CCW motion from the POV of the observer.

Defined at line 212 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class BlendMode : uint32_t
Name Value Comments
kSrc 1u

Indicates that the source pixels replace the destination pixels. In other words,
the source pixels are treated as opaque, regardless of what alpha values are set.

kSrcOver 2u

The source pixels are drawn over the destination pixels. The final pixel color
that is displayed is calculated as: C_src + (1.0 - alpha_src) * C_dst).

The set of possible blending functions to choose from when determining how an image should

be composited on top of other images.

Defined at line 241 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class ImageFlip : uint32_t
Name Value Comments
kNone 0u --
kLeftRight 1u

Let V be the vertical axis of reflection, positioned at width/2. Then each pixel's x
coordinate is reflected across V. The y coordinates remain constant. For instance:
|1234| |4321|
|abcd| would become |dcba|

kUpDown 2u

Let H be the horizontal axis of reflection, positioned at height/2. Then each pixel's y
coordinate is reflected across H. The x coordinates remain constant. For instance:
|1234| |abcd|
|abcd| would become |1234|

The set of possible image flip functions to choose from when determining how the image texture

should be displayed.

Defined at line 356 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class ParentViewportStatus : uint32_t
Name Value
kConnectedToDisplay 1u
kDisconnectedFromDisplay 2u

ParentViewportWatchers will be informed when they are actively attached to a output display

(either directly, or through a chain of parent Viewports) and when they are not. Until they are

connected to a display, some pieces of information (such as pixel scale) may be unavailable.

Defined at line 392 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class ChildViewStatus : uint32_t
Name Value Comments
kContentHasPresented 1u

The underlying Flatland instance has connected its View, called [`Present`], and the
acquisition fences of the [`Present`] call have all be reached, indicating that it has some
content ready to be displayed, and NOT that the child content has actually been shown on the
screen (a common use case is for the parent to wait for the child content to be ready before
attaching the child to the global scene graph).

Defined at line 415 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

enum class Rotation : uint32_t
Name Value
kCw0Degrees 0u
kCw90Degrees 1u
kCw180Degrees 2u
kCw270Degrees 3u

The rotation to be applied to the image.

If a given display is rotated, say, 270 degrees according to its

`display_info` config file, then applying the equal and opposite rotation,

[`CW_270_DEGREES`], should cancel the display rotation leading to a

correctly rendered screenshot.

Clients should allocate an image according to the final dimensions they

ultimately want to use, i.e. after rotation. These would be identical

to the `width` and `height` values found in the `display_info` config file.

Defined at line 613 of file fidling/gen/sdk/fidl/fuchsia.ui.composition/fuchsia.ui.composition/cpp/fidl/fuchsia.ui.composition/cpp/common_types.h

Records

Functions

  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::RegisterBufferCollectionError & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::BufferCollectionExportToken & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::BufferCollectionImportToken & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::RegisterBufferCollectionUsage & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::RegisterBufferCollectionUsages & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::RegisterBufferCollectionArgs & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::AllocatorRegisterBufferCollectionRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::AllocatorRegisterBufferCollectionResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::AllocatorRegisterBufferCollectionResult & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandError & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::Orientation & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::BlendMode & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::BlendMode2 & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ColorRgba & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ImageFlip & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::LayoutInfo & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ParentViewportStatus & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ParentViewportWatcherGetLayoutResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ParentViewportWatcherGetStatusResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ChildViewStatus & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ChildViewWatcherGetStatusResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ChildViewWatcherGetViewRefResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ViewportProperties & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ImageProperties & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TransformId & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ContentId & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::PresentArgs & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::OnNextFrameBeginValues & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ViewBoundProtocols & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::HitTestInteraction & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::HitRegion & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandPresentRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandOnNextFrameBeginRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandOnFramePresentedRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandOnErrorRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandCreateViewRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandCreateView2Request & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandCreateTransformRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetTranslationRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetOrientationRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetScaleRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetOpacityRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetClipBoundaryRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandAddChildRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandRemoveChildRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandReplaceChildrenRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetRootTransformRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetHitRegionsRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetInfiniteHitRegionRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandCreateViewportRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandCreateImageRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetImageSampleRegionRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetImageDestinationSizeRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetImageBlendingFunctionRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetImageBlendModeRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetImageOpacityRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetImageFlipRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandCreateFilledRectRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetSolidFillRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandReleaseFilledRectRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetContentRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetViewportPropertiesRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandReleaseTransformRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandReleaseViewportRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandReleaseViewportResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandReleaseImageRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandSetDebugNameRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandDisplaySetContentRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FlatlandDisplaySetDevicePixelRatioRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureError & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::Rotation & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureConfig & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::GetNextFrameArgs & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::FrameInfo & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureConfigureResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureConfigureResult & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureGetNextFrameResult & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureReleaseFrameRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureReleaseFrameResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenCaptureReleaseFrameResult & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenshotFormat & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenshotTakeRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenshotTakeResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenshotTakeFileRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::ScreenshotTakeFileResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TrustedFlatlandConfig & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TrustedFlatlandFactoryError & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TrustedFlatlandFactoryCreateFlatlandRequest & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TrustedFlatlandFactoryCreateFlatlandResponse & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TrustedFlatlandFactoryCreateFlatlandResult & value)
  • std::ostream & operator<< (std::ostream & os, const ::fuchsia_ui_composition::TrustedFlatlandReleaseImageImmediatelyRequest & value)