pw_graphics/pw_framebuffer/docs.rst

.. _module-pw_framebuffer:

==============
pw_framebuffer
==============
.. pigweed-module::
   :name: pw_framebuffer

.. seealso::
   This module is part of SEED :ref:`seed-0104`.

   Other Pigweed graphics modules:
   :bdg-ref-primary-line:`module-pw_color`
   :bdg-ref-primary-line:`module-pw_geometry`
   :bdg-ref-primary-line:`module-pw_framebuffer`
   :bdg-ref-primary-line:`module-pw_draw`

.. cpp:namespace-push:: pw::framebuffer

:cpp:class:`Framebuffer` is a small class that provides access
to a pixel buffer. It keeps a copy of the pixel buffer metadata and provides
accessor methods for those values.

:cpp:class:`Framebuffer` is a moveable class that is intended
to signify read/write privileges to the underlying pixel data. This makes it
easier to track when the pixel data may be read from, or written to, without
conflict.

The Framebuffer does not own the underlying pixel buffer. In other words the
deletion of a framebuffer will not free the underlying pixel data.

Framebuffers do not have methods for reading or writing to the underlying pixel
buffer. This is the responsibility of the the selected graphics library which
can be given the pixel buffer pointer retrieved by calling
:cpp:func:`Framebuffer::data()`.

.. cpp:namespace-pop::

-------------
API reference
-------------
.. doxygengroup:: pw_framebuffer
   :members: