xref: /aosp_15_r20/external/skia/experimental/rust_png/encoder/SkPngRustEncoder.h (revision c8dee2aa9b3f27cf6c858bd81872bdeb2c07ed17)
1*c8dee2aaSAndroid Build Coastguard Worker /*
2*c8dee2aaSAndroid Build Coastguard Worker  * Copyright 2024 Google LLC.
3*c8dee2aaSAndroid Build Coastguard Worker  *
4*c8dee2aaSAndroid Build Coastguard Worker  * Use of this source code is governed by a BSD-style license that can be
5*c8dee2aaSAndroid Build Coastguard Worker  * found in the LICENSE file.
6*c8dee2aaSAndroid Build Coastguard Worker  */
7*c8dee2aaSAndroid Build Coastguard Worker #ifndef SkPngRustEncoder_DEFINED
8*c8dee2aaSAndroid Build Coastguard Worker #define SkPngRustEncoder_DEFINED
9*c8dee2aaSAndroid Build Coastguard Worker 
10*c8dee2aaSAndroid Build Coastguard Worker #include <memory>
11*c8dee2aaSAndroid Build Coastguard Worker 
12*c8dee2aaSAndroid Build Coastguard Worker #include "include/private/base/SkAPI.h"
13*c8dee2aaSAndroid Build Coastguard Worker 
14*c8dee2aaSAndroid Build Coastguard Worker class SkEncoder;
15*c8dee2aaSAndroid Build Coastguard Worker class SkPixmap;
16*c8dee2aaSAndroid Build Coastguard Worker class SkWStream;
17*c8dee2aaSAndroid Build Coastguard Worker 
18*c8dee2aaSAndroid Build Coastguard Worker namespace SkPngRustEncoder {
19*c8dee2aaSAndroid Build Coastguard Worker 
20*c8dee2aaSAndroid Build Coastguard Worker /**
21*c8dee2aaSAndroid Build Coastguard Worker  *  Encode the |src| pixels to the |dst| stream.
22*c8dee2aaSAndroid Build Coastguard Worker  *  |options| may be used to control the encoding behavior.
23*c8dee2aaSAndroid Build Coastguard Worker  *
24*c8dee2aaSAndroid Build Coastguard Worker  *  Returns true on success.  Returns false on an invalid or unsupported |src|.
25*c8dee2aaSAndroid Build Coastguard Worker  *
26*c8dee2aaSAndroid Build Coastguard Worker  *  TODO(https://crbug.com/379312510): Add support for `SkPngEncoder::Options`
27*c8dee2aaSAndroid Build Coastguard Worker  *  like:
28*c8dee2aaSAndroid Build Coastguard Worker  *  * Comments - `tEXt` chunks.
29*c8dee2aaSAndroid Build Coastguard Worker  *  * Color profile - `iCCP` chunk.
30*c8dee2aaSAndroid Build Coastguard Worker  *  * Filter choice and compression level
31*c8dee2aaSAndroid Build Coastguard Worker  */
32*c8dee2aaSAndroid Build Coastguard Worker SK_API bool Encode(SkWStream* dst, const SkPixmap& src);
33*c8dee2aaSAndroid Build Coastguard Worker 
34*c8dee2aaSAndroid Build Coastguard Worker /**
35*c8dee2aaSAndroid Build Coastguard Worker  *  Create a png encoder that will encode the |src| pixels to the |dst| stream.
36*c8dee2aaSAndroid Build Coastguard Worker  *  |options| may be used to control the encoding behavior.
37*c8dee2aaSAndroid Build Coastguard Worker  *
38*c8dee2aaSAndroid Build Coastguard Worker  *  The primary use of this is incremental encoding of the pixels.
39*c8dee2aaSAndroid Build Coastguard Worker  *
40*c8dee2aaSAndroid Build Coastguard Worker  *  |dst| is unowned but must remain valid for the lifetime of the object.
41*c8dee2aaSAndroid Build Coastguard Worker  *
42*c8dee2aaSAndroid Build Coastguard Worker  *  This returns nullptr on an invalid or unsupported |src|.
43*c8dee2aaSAndroid Build Coastguard Worker  *
44*c8dee2aaSAndroid Build Coastguard Worker  *  TODO(https://crbug.com/379312510): Add support for `SkPngEncoder::Options`.
45*c8dee2aaSAndroid Build Coastguard Worker  */
46*c8dee2aaSAndroid Build Coastguard Worker SK_API std::unique_ptr<SkEncoder> Make(SkWStream* dst, const SkPixmap& src);
47*c8dee2aaSAndroid Build Coastguard Worker 
48*c8dee2aaSAndroid Build Coastguard Worker }  // namespace SkPngRustEncoder
49*c8dee2aaSAndroid Build Coastguard Worker 
50*c8dee2aaSAndroid Build Coastguard Worker #endif  // SkPngRustEncoder_DEFINED
51