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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/*
* Copyright 2019-2021 Diligent Graphics LLC
* Copyright 2015-2019 Egor Yusov
*
* 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
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*
* In no event and under no legal theory, whether in tort (including negligence),
* contract, or otherwise, unless required by applicable law (such as deliberate
* and grossly negligent acts) or agreed to in writing, shall any Contributor be
* liable for any damages, including any direct, indirect, special, incidental,
* or consequential damages of any character arising as a result of this License or
* out of the use or inability to use the software (including but not limited to damages
* for loss of goodwill, work stoppage, computer failure or malfunction, or any and
* all other commercial damages or losses), even if such Contributor has been advised
* of the possibility of such damages.
*/
#include "../interface/Image.h"
DILIGENT_BEGIN_NAMESPACE(Diligent)
// clang-format off
/// PNG decoding result.
DILIGENT_TYPED_ENUM(DECODE_PNG_RESULT, Uint32)
{
/// Decoding was successful.
DECODE_PNG_RESULT_OK = 0,
/// Invalid arguments (e.g. null pointer).
DECODE_PNG_RESULT_INVALID_ARGUMENTS,
/// Invalid signature (the encoded file is not a PNG file).
DECODE_PNG_RESULT_INVALID_SIGNATURE,
/// Failed to initialize the decoder.
DECODE_PNG_RESULT_INITIALIZATION_FAILED,
/// Invalid bit depth.
DECODE_PNG_RESULT_INVALID_BIT_DEPTH,
/// An unexpected error occurred while decoding the file.
DECODE_PNG_RESULT_DECODING_ERROR
};
/// PNG encoding result
DILIGENT_TYPED_ENUM(ENCODE_PNG_RESULT, Uint32)
{
/// Encoding finished successfully.
ENCODE_PNG_RESULT_OK = 0,
/// Invalid arguments (e.g. null pointer).
ENCODE_PNG_RESULT_INVALID_ARGUMENTS,
/// Failed to initialize the encoder.
ENCODE_PNG_RESULT_INITIALIZATION_FAILED
};
// clang-format on
/// Decodes png image.
/// \param [in] pSrcPngBits - PNG image encoded bits.
/// \param [out] pDstPixels - Decoded pixels data blob. The pixels are always tightly packed
/// (for instance, components of 3-channel image will be written as |r|g|b|r|g|b|r|g|b|...).
/// \param [out] pDstImgDesc - Decoded image description.
/// \return Decoding result, see Diligent::DECODE_PNG_RESULT.
DECODE_PNG_RESULT DILIGENT_GLOBAL_FUNCTION(DecodePng)(IDataBlob* pSrcPngBits,
IDataBlob* pDstPixels,
ImageDesc* pDstImgDesc);
/// Encodes an image into PNG format.
/// \param [in] pSrcPixels - Source pixels. The pixels must be tightly packed
/// (for instance, components of 3-channel image must be stored as |r|g|b|r|g|b|r|g|b|...).
/// The number of components is defined by the PngColorType parameter.
/// \param [in] Width - Image width.
/// \param [in] Height - Image height.
/// \param [in] StrideInBytes - Image data stride, in bytes.
/// \param [in] PngColorType - PNG color type (PNG_COLOR_TYPE_RGB, PNG_COLOR_TYPE_RGBA, etc.).
/// The color type defines the number of color components, which must be
/// tightly packed.
/// \param [out] pDstPngBits - Encoded PNG image bits.
/// \return Encoding result, see Diligent::ENCODE_PNG_RESULT.
ENCODE_PNG_RESULT DILIGENT_GLOBAL_FUNCTION(EncodePng)(const Uint8* pSrcPixels,
Uint32 Width,
Uint32 Height,
Uint32 StrideInBytes,
int PngColorType,
IDataBlob* pDstPngBits);
DILIGENT_END_NAMESPACE // namespace Diligent
|
