class Dimensions

Defined at line 31 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

FIDL type [`fuchsia.math/SizeU`] representation useful for the display stack.

Similar to the VkExtent2D concept in the Vulkan API.

See `::fuchsia_math::wire::SizeU` for references.

Instances represent the dimensions (sizes) of rectangular axis-aligned

regions inside raster images. Instances are guaranteed to represent

dimensions supported by the display stack.

The canonical representation of empty region dimensions is 0x0 (width and

height are both zero). Instances are guaranteed to only use the canonical

representation for empty region dimensions.

This is a value type. Instances can be stored in containers. Copying, moving

and destruction are trivial.

Public Members

static const int kMaxWidth
static const int kMaxHeight

Public Methods

void Dimensions (const Dimensions & )

Defined at line 59 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

void Dimensions (Dimensions && )

Defined at line 60 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

Dimensions & operator= (const Dimensions & )

Defined at line 61 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

Dimensions & operator= (Dimensions && )

Defined at line 62 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

void ~Dimensions ()

Defined at line 63 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

int32_t width ()

Guaranteed to be in [0, `kMaxWidth`].

Defined at line 71 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

int32_t height ()

Guaranteed to be in [0, `kMaxHeight`].

Defined at line 74 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

bool IsEmpty ()

True iff the dimensions represent an empty region.

Defined at line 77 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

bool IsValid (const fuchsia_math::wire::SizeU & fidl_size)

True iff `fidl_size` is convertible to a valid Dimensions instance.

Defined at line 96 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

Dimensions From (const fuchsia_math::wire::SizeU & fidl_size)

`fidl_size` must be convertible to a valid Dimensions instance.

This is not a constructor to allow designated initializer syntax. Making

this a constructor would introduce ambiguity when designated initializer

syntax is used, because `fuchsia.math/SizeU` has the same field names as

our supported designated initializer syntax.

Defined at line 121 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

void Dimensions (const Dimensions::ConstructorArgs & args)

Constructor that enables the designated initializer syntax.

NOLINTNEXTLINE(google-explicit-constructor)

Defined at line 115 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

fuchsia_math::wire::SizeU ToFidl ()

Defined at line 135 of file ../../src/graphics/display/lib/api-types/cpp/dimensions.h

Friends

bool Dimensions (const Dimensions & lhs, const Dimensions & rhs)
bool Dimensions (const Dimensions & lhsconst Dimensions & rhs)