HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImfTiledInputPart.h
Go to the documentation of this file.
1 //
2 // SPDX-License-Identifier: BSD-3-Clause
3 // Copyright (c) Contributors to the OpenEXR Project.
4 //
5 
6 #ifndef IMFTILEDINPUTPART_H_
7 #define IMFTILEDINPUTPART_H_
8 
9 #include "ImfForward.h"
10 
11 #include "ImfTileDescription.h"
12 #include <ImathBox.h>
13 
14 OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
15 
16 //-----------------------------------------------------------------------------
17 // class TiledInputPart:
18 //
19 // Same interface as TiledInputFile. Please have a reference to TiledInputFile.
20 //-----------------------------------------------------------------------------
21 
22 class IMF_EXPORT_TYPE TiledInputPart
23 {
24 public:
25  IMF_EXPORT
26  TiledInputPart (MultiPartInputFile& multiPartFile, int partNumber);
27 
28  IMF_EXPORT
29  const char* fileName () const;
30  IMF_EXPORT
31  const Header& header () const;
32  IMF_EXPORT
33  int version () const;
34  IMF_EXPORT
35  void setFrameBuffer (const FrameBuffer& frameBuffer);
36  IMF_EXPORT
37  const FrameBuffer& frameBuffer () const;
38  IMF_EXPORT
39  bool isComplete () const;
40  IMF_EXPORT
41  unsigned int tileXSize () const;
42  IMF_EXPORT
43  unsigned int tileYSize () const;
44  IMF_EXPORT
45  LevelMode levelMode () const;
46  IMF_EXPORT
47  LevelRoundingMode levelRoundingMode () const;
48  IMF_EXPORT
49  int numLevels () const;
50  IMF_EXPORT
51  int numXLevels () const;
52  IMF_EXPORT
53  int numYLevels () const;
54  IMF_EXPORT
55  bool isValidLevel (int lx, int ly) const;
56  IMF_EXPORT
57  int levelWidth (int lx) const;
58  IMF_EXPORT
59  int levelHeight (int ly) const;
60  IMF_EXPORT
61  int numXTiles (int lx = 0) const;
62  IMF_EXPORT
63  int numYTiles (int ly = 0) const;
64  IMF_EXPORT
65  IMATH_NAMESPACE::Box2i dataWindowForLevel (int l = 0) const;
66  IMF_EXPORT
67  IMATH_NAMESPACE::Box2i dataWindowForLevel (int lx, int ly) const;
68  IMF_EXPORT
69  IMATH_NAMESPACE::Box2i dataWindowForTile (int dx, int dy, int l = 0) const;
70  IMF_EXPORT
71  IMATH_NAMESPACE::Box2i
72  dataWindowForTile (int dx, int dy, int lx, int ly) const;
73  IMF_EXPORT
74  void readTile (int dx, int dy, int l = 0);
75  IMF_EXPORT
76  void readTile (int dx, int dy, int lx, int ly);
77  IMF_EXPORT
78  void readTiles (int dx1, int dx2, int dy1, int dy2, int lx, int ly);
79  IMF_EXPORT
80  void readTiles (int dx1, int dx2, int dy1, int dy2, int l = 0);
81  IMF_EXPORT
82  void rawTileData (
83  int& dx,
84  int& dy,
85  int& lx,
86  int& ly,
87  const char*& pixelData,
88  int& pixelDataSize);
89 
90 private:
91  TiledInputFile* file;
92  // for internal use - allow TiledOutputFile access to file for copyPixels
93  friend class TiledOutputFile;
94 };
95 
96 OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
97 
98 #endif /* IMFTILEDINPUTPART_H_ */
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
Definition: ImfNamespace.h:83
ImfTileDescription.h
LevelRoundingMode
enum IMF_EXPORT_ENUM LevelRoundingMode
Definition: ImfTileDescription.h:28
MultiPartInputFile
TODO: Document this.
Definition: ImfMultiPartInputFile.h:20
Box2i
Box< V2i > Box2i
2D box of base type int.
Definition: ImathBox.h:143
IMF_EXPORT
#define IMF_EXPORT
Definition: ImfExport.h:54
ImfForward.h
GT_Names::version
GT_API const UT_StringHolder version
TiledInputPart
class IMF_EXPORT_TYPE TiledInputPart
Definition: ImfForward.h:44
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
#define OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
Definition: ImfNamespace.h:80
LevelMode
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER enum IMF_EXPORT_ENUM LevelMode
Definition: ImfTileDescription.h:19
ImathBox.h
IMF_EXPORT_TYPE
#define IMF_EXPORT_TYPE
Definition: ImfExport.h:57