blob: 9208dfe5dbe3e34db15ce76a9fec4e742cd55c19 [file] [log] [blame]
// Copyright 2024 The Pigweed Authors
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
#include <cstdint>
#include "pw_color/color.h"
#include "pw_framebuffer/framebuffer.h"
#include "pw_framebuffer/reader.h"
namespace pw::framebuffer {
/// @ingroup pw_framebuffer
/// An interface to Framebuffer to simplify writing (and reading) pixel values
/// from a framebuffer.
/// Note: This implementation is not designed for performance, and is intended
/// to be used for development (testing) and other cases where drawing
/// performance is not important.
class FramebufferWriter : public FramebufferReader {
FramebufferWriter(Framebuffer& framebuffer);
/// Set the pixel at (x, y), if within the framebuffer bounds, to the
/// specified pixel value.
void SetPixel(uint16_t x, uint16_t y, pw::color::color_rgb565_t pixel_value);
/// Copy the pixels from another framebuffer into the one managed by this
/// writer at position (x, y).
void Blit(const Framebuffer& fb, uint16_t x, uint16_t y);
/// Fill the entire framebuffer with the specified pixel value.
void Fill(pw::color::color_rgb565_t pixel_value);
} // namespace pw::framebuffer