include/canvas/rendering/icolorbuffer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_CANVAS_RENDERING_ICOLORBUFFER_HXX
  21 #define INCLUDED_CANVAS_RENDERING_ICOLORBUFFER_HXX
  22
  23 #include <sal/types.h>
  24
  25 namespace canvas
  26 {
  27     /** Interface for a raw memory pixel container
  28
  29         Use this interface to represent a surface of raw pixel (e.g. a
  30         bitmap) to the canvas rendering framework.
  31      */
  32     struct IColorBuffer
  33     {
  34         /// The underlying pixel format for this buffer
  35         enum class Format
  36         {
  37             // 32-bit ARGB pixel format with alpha, 8 bits per channel.
  38             A8R8G8B8,
  39
  40             // 32-bit RGB pixel format, 8 bits per channel.
  41             X8R8G8B8
  42         };
  43
  44         virtual ~IColorBuffer() {}
  45
  46         /** Get a pointer to the raw memory bits of the pixel
  47          */
  48         virtual sal_uInt8* lock() const = 0;
  49
  50         /** unlock previous locked buffer
  51         */
  52         virtual void unlock() const = 0;
  53
  54         /** Get width in pixel
  55          */
  56         virtual sal_uInt32 getWidth() const = 0;
  57
  58         /** Get height in pixel
  59          */
  60         virtual sal_uInt32 getHeight() const = 0;
  61
  62         /** Offset, in bytes, between consecutive scan lines of the bitmap.
  63             If the stride is positive, the bitmap is top-down.
  64             If the stride is negative, the bitmap is bottom-up.
  65             The returned value is only valid while the buffer is locked.
  66          */
  67         virtual sal_uInt32 getStride() const = 0;
  68
  69         /** Get format of the color buffer
  70          */
  71         virtual Format getFormat() const = 0;
  72     };
  73 }
  74
  75 #endif // INCLUDED_CANVAS_RENDERING_ICOLORBUFFER_HXX
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */