include/basebmp/drawmodes.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_BASEBMP_DRAWMODES_HXX
  21 #define INCLUDED_BASEBMP_DRAWMODES_HXX
  22
  23 /* Definition of Draw modes */
  24
  25 namespace basebmp
  26 {
  27     enum DrawMode
  28     {
  29         /** Default draw mode, which simply renders pixel in the
  30             requested color
  31          */
  32         DrawMode_PAINT,
  33
  34         /** XOR draw mode, which XORs each existing pixel value with
  35             the new color.
  36
  37             The result of this XOR operation strongly depends on the
  38             underlying pixel format, as it is defined by the bitwise
  39             XOR of the (potentially palette-looked-up) color value and
  40             the existing pixel content (being it true color or a
  41             palette index).
  42          */
  43         DrawMode_XOR
  44     };
  45 }
  46
  47 #endif /* INCLUDED_BASEBMP_DRAWMODES_HXX */
  48
  49 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */