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