Skip to content

[DOCS] Enhance gvawatermark documentation, element description #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tbujewsk merged 2 commits into from
Mar 17, 2026
Merged

[DOCS] Enhance gvawatermark documentation, element description #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6de7f91
[DOCS] Enhance gvawatermark documentation with additional display con…
tbujewsk Mar 13, 2026
d706942
Merge branch 'main' into watermark_md_update
tbujewsk Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions docs/source/elements/gvawatermark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,22 +68,29 @@ Element Properties:
Boolean. Default: false
displ-cfg : Comma separated list of KEY=VALUE parameters of displayed notations.
Available options:
show-labels=<bool> enable or disable displaying text labels, default true
font-scale=<double 0.1 to 2.0> scale factor for text labels, default 0.5
thickness=<uint> bounding box thickness, default 2
color-idx=<int> color index for bounding box, keypoints, and text, default -1 (use default colors: 0 red, 1 green, 2 blue)
draw-txt-bg=<bool> enable or disable displaying text labels background, by enabling it the text color is set to white, default true
font-type=<string> font type for text labels, default triplex. Supported fonts: simplex, plain, duplex, complex, triplex, complex_small, script_simplex, script_complex
text-x=<float> x position (pixels) for full-frame text (e.g. from gvagenai), default 0
text-y=<float> y position (pixels) for full-frame text (e.g. from gvagenai), default 25
enable-blur=<bool> enable ROI blurring for privacy protection, default false
NOTE : this option is supported only for CPU for now.
show-blur-roi=<string> colon-separated list of object labels to blur (e.g., "face:person")
hide-blur-roi=<string> colon-separated list of labels to exclude from blurring (show-blur-roi takes precedence)
* show-labels=<bool> enable or disable displaying text labels, default true
* font-scale=<double 0.1 to 2.0> scale factor for text labels, default 0.5
* thickness=<uint> bounding box thickness, default 2
* color-idx=<int> color index for bounding box, keypoints, and text, default -1 (use default colors: 0 red, 1 green, 2 blue)
* font-type=<string> font type for text labels, default triplex. Supported fonts: simplex, plain, duplex, complex, triplex, complex_small, script_simplex, script_complex
* draw-txt-bg=<bool> enable or disable displaying text labels background, by enabling it the text color is set to white, default true
* show-roi=<string> colon-separated list of labels to include (only these objects will be shown), default empty
* hide-roi=<string> colon-separated list of labels to exclude (these objects will be hidden), default empty
* enable-blur=<bool> enable ROI blurring for privacy protection, default false
NOTE : show-blur-roi takes precedence over hide-blur-roi when both are specified
NOTE : this option is supported only for CPU for now.
* show-blur-roi=<string> colon-separated list of object labels to blur (e.g., "face:person")
* hide-blur-roi=<string> colon-separated list of labels to exclude from blurring (show-blur-roi takes precedence)
* text-x=<float> x position (pixels) for full-frame text (e.g. from gvagenai), default 0
* text-y=<float> y position (pixels) for full-frame text (e.g. from gvagenai), default 25

e.g.: displ-cfg=show-labels=false
e.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=plain
e.g.: displ-cfg=show-labels=true,show-roi=person:car:truck
e.g.: displ-cfg=show-labels=true,hide-roi=bottle:cup
e.g.: displ-cfg=enable-blur=true,show-blur-roi=face:person
e.g.: displ-cfg=text-y=680 (place full-frame text near bottom of a 720p frame)

flags: readable, writable
String. Default: null
device : Supported devices are CPU and GPU. Default is CPU on system memory and GPU on video memory
Expand Down
7 changes: 5 additions & 2 deletions src/monolithic/gst/elements/gvawatermark/gstgvawatermarkimpl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,14 @@ enum { PROP_0, PROP_DEVICE, PROP_OBB, PROP_DISPL_AVGFPS, PROP_DISPL_CFG };
"\t\t\thide-blur-roi=<string> colon-separated list of object labels to exclude from blurring\n" \
"\t\t\tNOTE: show-blur-roi takes precedence over hide-blur-roi when both are specified\n" \
"\t\t\tNOTE: currently this option is only supported for CPU\n" \
"\t\t\ttext-x=<float> x position (pixels) for full-frame text (e.g. from gvagenai), default 0\n" \
"\t\t\ttext-y=<float> y position (pixels) for full-frame text (e.g. from gvagenai), default 25\n" \
"\t\t\te.g.: displ-cfg=show-labels=false\n" \
"\t\t\te.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=simplex\n" \
"\t\t\te.g.: displ-cfg=font-scale=0.5,thickness=3,color-idx=2,font-type=plain\n" \
"\t\t\te.g.: displ-cfg=show-labels=true,show-roi=person:car:truck\n" \
"\t\t\te.g.: displ-cfg=show-labels=true,hide-roi=bottle:cup\n" \
"\t\t\te.g.: displ-cfg=enable-blur=true,show-blur-roi=face:person\n"
"\t\t\te.g.: displ-cfg=enable-blur=true,show-blur-roi=face:person\n" \
"\t\t\te.g.: displ-cfg=text-y=680 (place full-frame text near bottom of a 720p frame)\n"

G_END_DECLS

Expand Down
Loading