VTK  9.2.6
vtkTextureIO.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTextureIO.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
21 #ifndef vtkTextureIO_h
22 #define vtkTextureIO_h
23 
24 #include "vtkPixelExtent.h" // for pixel extent
25 #include "vtkRenderingLICOpenGL2Module.h" // for export
26 
27 // included vtkSystemIncludes in vtkPixelExtent
28 #include <cstddef> // for NULL
29 #include <deque> // for deque
30 #include <string> // for string
31 
32 class vtkTextureObject;
33 
34 class VTKRENDERINGLICOPENGL2_EXPORT vtkTextureIO
35 {
36 public:
40  static void Write(VTK_FILEPATH const char* filename, vtkTextureObject* texture,
41  const unsigned int* subset = nullptr, const double* origin = nullptr);
42 
46  static void Write(VTK_FILEPATH std::string filename, vtkTextureObject* texture,
47  const unsigned int* subset = nullptr, const double* origin = nullptr)
48  {
49  Write(filename.c_str(), texture, subset, origin);
50  }
51 
55  static void Write(VTK_FILEPATH std::string filename, vtkTextureObject* texture,
56  const vtkPixelExtent& subset, const double* origin = nullptr)
57  {
58  Write(filename.c_str(), texture, subset.GetDataU(), origin);
59  }
60 
64  static void Write(VTK_FILEPATH const char* filename, vtkTextureObject* texture,
65  const std::deque<vtkPixelExtent>& exts, const double* origin = nullptr);
66 
68 
71  static void Write(VTK_FILEPATH std::string filename, vtkTextureObject* texture,
72  const std::deque<vtkPixelExtent>& exts, const double* origin = nullptr)
73  {
74  Write(filename.c_str(), texture, exts, origin);
75  }
77 };
78 
79 #endif
80 // VTK-HeaderTest-Exclude: vtkTextureIO.h
static void Write(VTK_FILEPATH std::string filename, vtkTextureObject *texture, const vtkPixelExtent &subset, const double *origin=nullptr)
Write to disk as image data with subset(optional) at dataset origin(optional)
Definition: vtkTextureIO.h:55
static void Write(VTK_FILEPATH std::string filename, vtkTextureObject *texture, const std::deque< vtkPixelExtent > &exts, const double *origin=nullptr)
Write list of subsets to disk as multiblock image data at dataset origin(optional).
Definition: vtkTextureIO.h:71
static void Write(VTK_FILEPATH std::string filename, vtkTextureObject *texture, const unsigned int *subset=nullptr, const double *origin=nullptr)
Write to disk as image data with subset(optional) at dataset origin(optional)
Definition: vtkTextureIO.h:46
abstracts an OpenGL texture object.
#define VTK_FILEPATH
Representation of a cartesian pixel plane and common operations on it.
A small collection of I/O routines that write vtkTextureObject to disk for debugging.
Definition: vtkTextureIO.h:34
unsigned int * GetDataU()