getTextSize

Image processingfunctionOpenCV 5.0.0

import { getTextSize } from '@banou/opencv-wasm'

Use after await initOpenCV(). See the initialization and named imports guide.

ARGUMENTStext, fontFace, fontScale, thickness

FUNCTIONgetTextSize

RETURN TYPEgetTextSizeResult

Call structure. A void return can still write to destination arguments. The parameter descriptions define inputs, outputs and ownership.

Calculates the width and height of a text string.

The function cv::getTextSize calculates and returns the size of a box that contains the specified text. That is, the following code renders some text, the tight box surrounding it, and the baseline: :

    String text = "Funny text inside the box";
    int fontFace = FONT_HERSHEY_SCRIPT_SIMPLEX;
    double fontScale = 2;
    int thickness = 3;

    Mat img(600, 800, CV_8UC3, Scalar::all(0));

    int baseline=0;
    Size textSize = getTextSize(text, fontFace,
                                fontScale, thickness, &baseline);
    baseline += thickness;

    // center the text
    Point textOrg((img.cols - textSize.width)/2,
                  (img.rows + textSize.height)/2);

    // draw the box
    rectangle(img, textOrg + Point(0, baseline),
              textOrg + Point(textSize.width, -textSize.height),
              Scalar(0,0,255));
    // ... and the baseline first
    line(img, textOrg + Point(0, thickness),
         textOrg + Point(textSize.width, thickness),
         Scalar(0, 0, 255));

    // then put the text itself
    putText(img, text, textOrg, fontFace, fontScale,
            Scalar::all(255), thickness, 8);

See: putText

getTextSize(text: EmbindString, fontFace: number, fontScale: number, thickness: number): getTextSizeResult;

text: Input text string.
fontFace: Font to use, see #HersheyFonts.
fontScale: Font scale factor that is multiplied by the font-specific base size.
thickness: Thickness of lines used to render the text. See #putText for details.

Returns

The size of a box that contains the specified text. Scalar output parameters are returned as named fields in this object. Release returned native handles with using or delete(), including handles nested in results.

Upstream declaration ↗

These signatures describe this package. Upstream documentation can mention optional backends that are absent from this build. Check runtime compatibility before choosing a backend or file format.