Parameters for rendering shapes using the UberSDF shader. More...

#include <uber_sdf_parameters.h>

Public Types
enum class	Type { kCircle , kRect , kOval , kRoundedRect , kRoundedSuperellipseSymmetric }
	The type of primitive shape. More...

Static Public Member Functions
static UberSDFParameters	MakeRect (Color color, const Rect &rect, std::optional< StrokeParameters > stroke)
	Creates UberSDFParameters for a rectangle.

static UberSDFParameters	MakeCircle (Color color, const Point &center, Scalar radius, std::optional< StrokeParameters > stroke)
	Creates UberSDFParameters for a circle.

static UberSDFParameters	MakeOval (Color color, const Rect &bounds, std::optional< StrokeParameters > stroke)
	Creates UberSDFParameters for an Oval.

static UberSDFParameters	MakeRoundedRect (Color color, const Rect &rect, const RoundingRadii &radii, std::optional< StrokeParameters > stroke)
	Creates UberSDFParameters for a rounded rectangle.

static UberSDFParameters	MakeRoundedSuperellipse (Color color, const Rect &bounds, const RoundSuperellipseParam &round_superellipse_params, std::optional< StrokeParameters > stroke)
	Creates UberSDFParameters for an asymmetric round superellipse.

Public Attributes
Type	type
	The type of shape to render.

Color	color
	The color used for filling or stroking the shape.

Point	center
	The center point of the shape in local coordinates.

Point	size

std::optional< StrokeParameters >	stroke
	The stroke parameters. If std::nullopt, the shape is filled.

Point	superellipse_degree
	The degree (n) of the superellipse curve for the top and right octants.

Point	superellipse_semi_axis

Point	angle_span
	The angular span of the circular cap for the top and right octants.

float	octant_offset_c
	The geometric offset 'c' used to connect the two octants of each quadrant.

Point	circle_center_top

Point	circle_center_right

Point	superellipse_scale

Vector4	radii

Static Public Attributes
static constexpr Scalar	kAntialiasPixels = 1.0f

Detailed Description

Parameters for rendering shapes using the UberSDF shader.

Definition at line 21 of file uber_sdf_parameters.h.

Member Enumeration Documentation

◆ Type

enum class impeller::UberSDFParameters::Type

strong

The type of primitive shape.

Enumerator
kCircle
kRect
kOval
kRoundedRect
kRoundedSuperellipseSymmetric

Definition at line 27 of file uber_sdf_parameters.h.

                  {
    kCircle,
    kRect,
    kOval,
    kRoundedRect,
    kRoundedSuperellipseSymmetric,
  };

Member Function Documentation

◆ MakeCircle()

UberSDFParameters impeller::UberSDFParameters::MakeCircle	(	Color	color,
		const Point &	center,
		Scalar	radius,
		std::optional< StrokeParameters >	stroke
	)

static

Creates UberSDFParameters for a circle.

Definition at line 31 of file uber_sdf_parameters.cc.

                                          {
  // Both size parameters are the same, but this allows us to treat this
  // case as if it were an oval to share code down the line. We can also
  // share bounds calculations without having to test for circle vs rect.
  Point size = Point(radius, radius);
 
  return UberSDFParameters{.type = Type::kCircle,
                           .color = color,
                           .center = center,
                           .size = size,
                           .stroke = stroke};
}

References center, color, kCircle, size, stroke, and type.

Referenced by impeller::Canvas::DrawCircle(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), and impeller::testing::TEST().

◆ MakeOval()

UberSDFParameters impeller::UberSDFParameters::MakeOval	(	Color	color,
		const Rect &	bounds,
		std::optional< StrokeParameters >	stroke
	)

static

Creates UberSDFParameters for an Oval.

Definition at line 48 of file uber_sdf_parameters.cc.

                                          {
  Point size = Point(bounds.GetSize() * 0.5f);
  return UberSDFParameters{.type = Type::kOval,
                           .color = color,
                           .center = bounds.GetCenter(),
                           .size = size,
                           .stroke = stroke};
}

References color, impeller::TRect< T >::GetCenter(), impeller::TRect< T >::GetSize(), kOval, size, stroke, and type.

Referenced by impeller::Canvas::DrawOval(), impeller::testing::TEST(), and impeller::testing::TEST().

◆ MakeRect()

UberSDFParameters impeller::UberSDFParameters::MakeRect	(	Color	color,
		const Rect &	rect,
		std::optional< StrokeParameters >	stroke
	)

static

Creates UberSDFParameters for a rectangle.

Definition at line 9 of file uber_sdf_parameters.cc.

                                          {
  // Size is the x and y extents from the center of the rect.
  Point size = Point(rect.GetSize() * 0.5f);
 
  // Stroke may be changed from miter to bevel joins depending on the miter
  // limit.
  std::optional<StrokeParameters> adjusted_stroke =
      stroke && stroke->join == Join::kMiter && stroke->miter_limit < kSqrt2
          ? std::make_optional(StrokeParameters(
                {.width = stroke->width, .join = Join::kBevel}))
          : stroke;
 
  return UberSDFParameters{.type = Type::kRect,
                           .color = color,
                           .center = rect.GetCenter(),
                           .size = size,
                           .stroke = adjusted_stroke};
}

References color, impeller::TRect< T >::GetCenter(), impeller::TRect< T >::GetSize(), impeller::kBevel, impeller::kMiter, kRect, impeller::kSqrt2, size, stroke, and type.

Referenced by impeller::Canvas::DrawRect(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), impeller::testing::TEST(), and impeller::testing::TEST().

◆ MakeRoundedRect()

UberSDFParameters impeller::UberSDFParameters::MakeRoundedRect	(	Color	color,
		const Rect &	rect,
		const RoundingRadii &	radii,
		std::optional< StrokeParameters >	stroke
	)

static

Creates UberSDFParameters for a rounded rectangle.

Definition at line 60 of file uber_sdf_parameters.cc.

                                          {
  Point size = Point(rect.GetSize() * 0.5f);
  return UberSDFParameters{
      .type = Type::kRoundedRect,
      .color = color,
      .center = rect.GetCenter(),
      .size = size,
      .stroke = stroke,
      .radii = Vector4(radii.bottom_right.width, radii.top_right.width,
                       radii.bottom_left.width, radii.top_left.width)};
}

References color, impeller::TRect< T >::GetCenter(), impeller::TRect< T >::GetSize(), kRoundedRect, radii, size, stroke, and type.

Referenced by impeller::Canvas::DrawRoundRect(), and impeller::testing::TEST().

◆ MakeRoundedSuperellipse()

UberSDFParameters impeller::UberSDFParameters::MakeRoundedSuperellipse	(	Color	color,
		const Rect &	bounds,
		const RoundSuperellipseParam &	round_superellipse_params,
		std::optional< StrokeParameters >	stroke
	)

static

Creates UberSDFParameters for an asymmetric round superellipse.

Definition at line 76 of file uber_sdf_parameters.cc.

                                          {
  FML_DCHECK(round_superellipse_params.all_corners_same);
  Point center = bounds.GetCenter();
 
  RoundSuperellipseParam::Quadrant top_right =
      round_superellipse_params.top_right;
 
  Point size = Point(bounds.GetSize() * 0.5f);
 
  return UberSDFParameters{
      .type = Type::kRoundedSuperellipseSymmetric,
      .color = color,
      .center = center,
      .size = size,
      .stroke = stroke,
      .superellipse_degree = Point(top_right.top.se_n, top_right.right.se_n),
      .superellipse_semi_axis = Point(top_right.top.se_a, top_right.right.se_a),
      .angle_span = Point(top_right.top.circle_max_angle.radians,
                          top_right.right.circle_max_angle.radians),
      .octant_offset_c = top_right.top.se_a - top_right.right.se_a,
      .circle_center_top = top_right.top.circle_center,
      .circle_center_right = top_right.right.circle_center,
      .superellipse_scale = top_right.signed_scale.Abs(),
      .radii = Vector4(top_right.top.circle_radius,
                       top_right.right.circle_radius, 0.0f, 0.0f)};
}

Referenced by impeller::Canvas::DrawRoundSuperellipse(), and impeller::testing::TEST().

Member Data Documentation

◆ angle_span

Point impeller::UberSDFParameters::angle_span

The angular span of the circular cap for the top and right octants.

Definition at line 90 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ center

Point impeller::UberSDFParameters::center

The center point of the shape in local coordinates.

Definition at line 72 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFGeometry::CoversArea(), MakeCircle(), MakeRoundedSuperellipse(), and impeller::UberSDFContents::Render().

◆ circle_center_right

Point impeller::UberSDFParameters::circle_center_right

The circular cap center for the right octant of each quadrant.

Definition at line 101 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ circle_center_top

Point impeller::UberSDFParameters::circle_center_top

The circular cap center for the top octant of each quadrant.

Definition at line 97 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ color

Color impeller::UberSDFParameters::color

The color used for filling or stroking the shape.

Definition at line 69 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::ApplyColorFilter(), impeller::UberSDFContents::GetColor(), MakeCircle(), MakeOval(), MakeRect(), MakeRoundedRect(), MakeRoundedSuperellipse(), and impeller::UberSDFContents::Render().

◆ kAntialiasPixels

constexpr Scalar impeller::UberSDFParameters::kAntialiasPixels = 1.0f

staticconstexpr

The amount by which the UberSDF shader fades the edge of the drawn shapes, in pixels.

Definition at line 24 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFGeometry::CoversArea(), and impeller::UberSDFContents::Render().

◆ octant_offset_c

float impeller::UberSDFParameters::octant_offset_c

The geometric offset 'c' used to connect the two octants of each quadrant.

Definition at line 93 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ radii

Vector4 impeller::UberSDFParameters::radii

Rounding radii for standard rounded rects and corner radii for circular caps of superellipses for top and right octants.

Definition at line 109 of file uber_sdf_parameters.h.

Referenced by MakeRoundedRect(), and impeller::UberSDFContents::Render().

◆ size

Point impeller::UberSDFParameters::size

For a rectangle, this is half the width and height. For a circle, this is the radius in both dimensions. For an oval, this is half the width and height of the bounds.

Definition at line 77 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFGeometry::CoversArea(), MakeCircle(), MakeOval(), MakeRect(), MakeRoundedRect(), MakeRoundedSuperellipse(), and impeller::UberSDFContents::Render().

◆ stroke

std::optional<StrokeParameters> impeller::UberSDFParameters::stroke

The stroke parameters. If std::nullopt, the shape is filled.

Definition at line 80 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFGeometry::CoversArea(), impeller::UberSDFGeometry::IsAxisAlignedRect(), MakeCircle(), MakeOval(), MakeRect(), MakeRoundedRect(), MakeRoundedSuperellipse(), and impeller::UberSDFContents::Render().

◆ superellipse_degree

Point impeller::UberSDFParameters::superellipse_degree

The degree (n) of the superellipse curve for the top and right octants.

Definition at line 83 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ superellipse_scale

Point impeller::UberSDFParameters::superellipse_scale

The scaling factors used to transform normalized superellipses to their true size.

Definition at line 105 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ superellipse_semi_axis

Point impeller::UberSDFParameters::superellipse_semi_axis

The semi-axis length of the superellipse curve for the top and right octants.

Definition at line 87 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::Render().

◆ type

Type impeller::UberSDFParameters::type

The type of shape to render.

Definition at line 66 of file uber_sdf_parameters.h.

Referenced by impeller::UberSDFContents::AsBackgroundColor(), impeller::UberSDFGeometry::CoversArea(), impeller::UberSDFGeometry::IsAxisAlignedRect(), MakeCircle(), MakeOval(), MakeRect(), MakeRoundedRect(), MakeRoundedSuperellipse(), and impeller::UberSDFContents::Render().

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

impeller/entity/contents/uber_sdf_parameters.h
impeller/entity/contents/uber_sdf_parameters.cc

Public Types

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Member Function Documentation

◆ MakeCircle()

◆ MakeOval()

◆ MakeRect()

◆ MakeRoundedRect()

◆ MakeRoundedSuperellipse()

Member Data Documentation

◆ angle_span

◆ center

◆ circle_center_right

◆ circle_center_top

◆ color

◆ kAntialiasPixels

◆ octant_offset_c

◆ radii

◆ size

◆ stroke

◆ superellipse_degree

◆ superellipse_scale

◆ superellipse_semi_axis

◆ type