.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "notcurses_capabilities" "3" "v2.2.3" "" ""
.hy
.SH NAME
.PP
notcurses_capabilities - runtime capability detection
.SH SYNOPSIS
.PP
\f[B]#include <notcurses/notcurses.h>\f[R]
.PP
\f[B]unsigned notcurses_supported_styles(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]unsigned notcurses_palette_size(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_cantruecolor(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canfade(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canchangecolor(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canopen_images(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canopen_videos(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canutf8(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_cansextant(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canbraille(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.PP
\f[B]bool notcurses_canpixel(const struct notcurses*
\f[R]\f[I]nc\f[R]\f[B]);\f[R]
.SH DESCRIPTION
.PP
\f[B]notcurses_supported_styles\f[R] returns a bitmask representing
those styles for which the terminal advertises support.
.PP
\f[B]notcurses_palette_size\f[R] returns the size of the terminal\[aq]s
palette, used for palette-indexed color.
It will always return at least 1.
This is independent of RGB TrueColor support.
No terminal is know to support more than 256-indexed color.
.PP
\f[B]notcurses_cantruecolor\f[R] returns \f[B]true\f[R] if the terminal
advertises support for RGB TrueColor.
Note that the RGB APIs of Notcurses can be used even in the absence of
terminal RGB support (Notcurses will map the RGB values to the palette).
.PP
\f[B]notcurses_canfade\f[R] returns \f[B]true\f[R] if Notcurses has a
means by which it can effect fades.
.PP
\f[B]notcurses_canchangecolor\f[R] returns \f[B]true\f[R] if the
terminal advertises support for changing its palette entries.
.PP
\f[B]notcurses_canopen_images\f[R] returns \f[B]true\f[R] if Notcurses
was built with multimedia support.
.PP
\f[B]notcurses_canopen_video\f[R] returns \f[B]true\f[R] if Notcurses
was built with multimedia support capable of decoding videos.
.PP
\f[B]notcurses_canutf8\f[R] returns \f[B]true\f[R] if the configured
locale uses UTF-8 encoding, and the locale was successfully loaded.
.PP
\f[B]notcurses_cansextant\f[R] returns \f[B]true\f[R] if the heuristics
suggest that the terminal can properly render Unicode 13 sextants.
.PP
\f[B]notcurses_canpixel\f[R] returns \f[B]true\f[R] if the terminal
advertises support for pixel graphics (e.g.
Sixel).
This function will not return \f[B]true\f[R] until
\f[B]notcurses_check_pixel_support\f[R] is called, and successfully
returns.
.PP
\f[B]notcurses_canbraille\f[R] returns \f[B]true\f[R] if Braille is
expected to work on the terminal.
.SH NOTES
.PP
Some terminals advertise support for TrueColor, but then downsample or
otherwise degrade the provided RGB.
In this case \f[B]notcurses_cantruecolor\f[R] will return
\f[B]true\f[R], but the full spectrum will not be available.
.SH RETURN VALUES
.SH SEE ALSO
.PP
\f[B]notcurses(3)\f[R], \f[B]notcurses_init(3)\f[R],
\f[B]notcurses_visual(3)\f[R], utf8(7)
.SH AUTHORS
nick black <nickblack@linux.com>.