Flutter Impeller
IMPELLER_HPP_NAMESPACE::Paragraph Class Referencefinal

#include <impeller.hpp>

Inheritance diagram for IMPELLER_HPP_NAMESPACE::Paragraph:
IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >

Public Member Functions

 Paragraph (ImpellerParagraph paragraph, AdoptTag tag)
 
float GetAlphabeticBaseline ()
 
float GetHeight ()
 
float GetIdeographicBaseline ()
 
uint32_t GetLineCount ()
 
float GetLongestLineWidth ()
 
float GetMaxIntrinsicWidth ()
 
float GetMaxWidth ()
 
float GetMinIntrinsicWidth ()
 
LineMetrics GetLineMetrics () const
 
GlyphInfo GlyphInfoAtCodeUnitIndex (size_t code_unit_index)
 
GlyphInfo GlyphInfoAtParagraphCoordinates (double x, double y)
 
ImpellerRange GetWordBoundary (size_t code_unit_index)
 
- Public Member Functions inherited from IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >
 Object ()=default
 
 Object (ImpellerParagraph object)
 
 Object (ImpellerParagraph object, AdoptTag)
 
 Object (Object &&other)
 
 Object (const Object &other)
 
 ~Object ()
 
Objectoperator= (Object &&other)
 
Objectoperator= (const Object &other)
 
ImpellerParagraph Get () const
 
 operator bool () const
 

Detailed Description

See also
ImpellerParagraph

Definition at line 814 of file impeller.hpp.

Constructor & Destructor Documentation

◆ Paragraph()

IMPELLER_HPP_NAMESPACE::Paragraph::Paragraph ( ImpellerParagraph  paragraph,
AdoptTag  tag 
)
inline

Member Function Documentation

◆ GetAlphabeticBaseline()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetAlphabeticBaseline ( )
inline

◆ GetHeight()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetHeight ( )
inline

◆ GetIdeographicBaseline()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetIdeographicBaseline ( )
inline
See also
ImpellerParagraphGetIdeographicBaseline

Definition at line 837 of file impeller.hpp.

837  {
838  return gGlobalProcTable.ImpellerParagraphGetIdeographicBaseline(Get());
839  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), and IMPELLER_HPP_NAMESPACE::gGlobalProcTable.

◆ GetLineCount()

uint32_t IMPELLER_HPP_NAMESPACE::Paragraph::GetLineCount ( )
inline
See also
ImpellerParagraphGetLineCount

Definition at line 844 of file impeller.hpp.

844  {
845  return gGlobalProcTable.ImpellerParagraphGetLineCount(Get());
846  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), and IMPELLER_HPP_NAMESPACE::gGlobalProcTable.

◆ GetLineMetrics()

LineMetrics IMPELLER_HPP_NAMESPACE::Paragraph::GetLineMetrics ( ) const
inline
See also
ImpellerParagraphGetLineMetrics

Definition at line 879 of file impeller.hpp.

879  {
880  auto metrics = gGlobalProcTable.ImpellerParagraphGetLineMetrics(Get());
881  gGlobalProcTable.ImpellerLineMetricsRetain(metrics);
882  return LineMetrics(metrics, AdoptTag::kAdopt);
883  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), IMPELLER_HPP_NAMESPACE::gGlobalProcTable, and IMPELLER_HPP_NAMESPACE::kAdopt.

◆ GetLongestLineWidth()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetLongestLineWidth ( )
inline
See also
ImpellerParagraphGetLongestLineWidth

Definition at line 851 of file impeller.hpp.

851  {
852  return gGlobalProcTable.ImpellerParagraphGetLongestLineWidth(Get());
853  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), and IMPELLER_HPP_NAMESPACE::gGlobalProcTable.

◆ GetMaxIntrinsicWidth()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetMaxIntrinsicWidth ( )
inline
See also
ImpellerParagraphGetMaxIntrinsicWidth

Definition at line 858 of file impeller.hpp.

858  {
859  return gGlobalProcTable.ImpellerParagraphGetMaxIntrinsicWidth(Get());
860  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), and IMPELLER_HPP_NAMESPACE::gGlobalProcTable.

◆ GetMaxWidth()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetMaxWidth ( )
inline

◆ GetMinIntrinsicWidth()

float IMPELLER_HPP_NAMESPACE::Paragraph::GetMinIntrinsicWidth ( )
inline
See also
ImpellerParagraphGetMinIntrinsicWidth

Definition at line 872 of file impeller.hpp.

872  {
873  return gGlobalProcTable.ImpellerParagraphGetMinIntrinsicWidth(Get());
874  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), and IMPELLER_HPP_NAMESPACE::gGlobalProcTable.

◆ GetWordBoundary()

ImpellerRange IMPELLER_HPP_NAMESPACE::Paragraph::GetWordBoundary ( size_t  code_unit_index)
inline
See also
ImpellerParagraphGetWordBoundary

Definition at line 912 of file impeller.hpp.

912  {
913  return gGlobalProcTable.ImpellerParagraphGetWordBoundary(Get(),
914  code_unit_index);
915  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), and IMPELLER_HPP_NAMESPACE::gGlobalProcTable.

◆ GlyphInfoAtCodeUnitIndex()

GlyphInfo IMPELLER_HPP_NAMESPACE::Paragraph::GlyphInfoAtCodeUnitIndex ( size_t  code_unit_index)
inline
See also
ImpellerParagraphCreateGlyphInfoAtCodeUnitIndexNew

Definition at line 888 of file impeller.hpp.

888  {
889  return GlyphInfo(
890  gGlobalProcTable.ImpellerParagraphCreateGlyphInfoAtCodeUnitIndexNew(
891  Get(), code_unit_index),
893  }

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), IMPELLER_HPP_NAMESPACE::gGlobalProcTable, and IMPELLER_HPP_NAMESPACE::kAdopt.

◆ GlyphInfoAtParagraphCoordinates()

GlyphInfo IMPELLER_HPP_NAMESPACE::Paragraph::GlyphInfoAtParagraphCoordinates ( double  x,
double  y 
)
inline
See also
ImpellerParagraphCreateGlyphInfoAtParagraphCoordinatesNew

Definition at line 898 of file impeller.hpp.

898  {
899  return GlyphInfo(
902  Get(), //
903  x, //
904  y //
905  ),
907  }
int32_t x
IMPELLER_EXPORT IMPELLER_NODISCARD ImpellerGlyphInfo IMPELLER_NULLABLE ImpellerParagraphCreateGlyphInfoAtParagraphCoordinatesNew(ImpellerParagraph IMPELLER_NONNULL paragraph, double x, double y)
Create a new instance of glyph info that can be queried for information about the glyph closest to th...

References IMPELLER_HPP_NAMESPACE::Object< ImpellerParagraph, ImpellerParagraphTraits >::Get(), IMPELLER_HPP_NAMESPACE::gGlobalProcTable, ImpellerParagraphCreateGlyphInfoAtParagraphCoordinatesNew(), IMPELLER_HPP_NAMESPACE::kAdopt, and x.


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