summaryrefslogtreecommitdiffstats
path: root/o3d/core/cross/texture_base.h
blob: 8adf8e147a956f4a3dc87d76e6a9d020a88588e9 (plain)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/*
 * Copyright 2009, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


// File containing a base class for texture objects.

#ifndef O3D_CORE_CROSS_TEXTURE_BASE_H_
#define O3D_CORE_CROSS_TEXTURE_BASE_H_

#include "core/cross/param.h"
#include "core/cross/param_object.h"

namespace o3d {

class Bitmap;
class Pack;
class Renderer;
class RenderSurface;

// The Texture class is a base class for image data used in texture
// mapping.  It is an abstract class.  Concrete implementations should
// implement the GetTextureHandle() member function.
class Texture : public ParamObject {
 public:
  typedef SmartPointer<Texture> Ref;
  typedef WeakPointer<Texture> WeakPointerType;

  enum Format {
    UNKNOWN_FORMAT,
    XRGB8,  // actual format in memory is B G R X
    ARGB8,  // actual format in memory is B G R A
    ABGR16F,
    R32F,
    ABGR32F,
    DXT1,
    DXT3,
    DXT5
  };

  // Defines how you want to access a texture when locking.
  enum AccessMode {
    kNone = 0,
    kReadOnly = 1,
    kWriteOnly = 2,
    kReadWrite = 3,
  };

  typedef unsigned RGBASwizzleIndices[4];

  // This is the maximum texture size we allow and hence the largest
  // render target and depth stencil as well. This is because it's the limit of
  // some low-end machines that are still pretty common.
  //
  // NOTE: class Bitmap supports a larger size. The plan is to expose Bitmap
  // to Javascript so you can download larger images, scale them, then put
  // them in a texture.
  static const int kMaxDimension = 2048;
  static const int kMaxLevels = 12;

  Texture(ServiceLocator* service_locator,
          Format format,
          int levels,
          bool enable_render_surfaces);
  virtual ~Texture() {}

  static const char* kLevelsParamName;

  // Returns the implementation-specific texture handle.
  virtual void* GetTextureHandle() const = 0;

  static bool IsCompressedFormat(Format format) {
    return format == DXT1 || format == DXT3 || format == DXT5;
  }

  bool IsCompressed() const {
    return IsCompressedFormat(format_);
  }

  bool alpha_is_one() const { return alpha_is_one_; }
  void set_alpha_is_one(bool value)  { alpha_is_one_ = value; }

  // Gets the levels.
  int levels() const {
    return levels_param_->value();
  }

  // Gets the format of the texture resource.
  Format format() const {
    return format_;
  }

  int update_count() {
    return update_count_;
  }

  int render_count() {
    CheckLastTextureUpdateRendered();
    return render_count_;
  }

  bool render_surfaces_enabled() const {
    return render_surfaces_enabled_;
  }

  // Generates mips.
  virtual void GenerateMips(int source_level, int num_levels) = 0;

  // Gets a RGBASwizzleIndices that contains a mapping from
  // RGBA to the internal format used by the graphics API.
  virtual const RGBASwizzleIndices& GetABGR32FSwizzleIndices() = 0;

  // Gets a weak pointer to us.
  WeakPointerType GetWeakPointer() const {
    return weak_pointer_manager_.GetWeakPointer();
  }

 protected:
  void set_levels(int levels) {
    levels_param_->set_read_only_value(levels);
  }

  void set_format(Format format) {
    format_ = format;
  }

  void TextureUpdated();

  Renderer* renderer_;

 private:
  void CheckLastTextureUpdateRendered();

  // The number of mipmap levels contained in this texture.
  ParamInteger::Ref levels_param_;

  // true if all the alpha values in this texture are 1.0.
  bool alpha_is_one_;

  // The data format of each pixel.
  Format format_;

  // Manager for weak pointers to us.
  WeakPointerType::WeakPointerManager weak_pointer_manager_;

  bool render_surfaces_enabled_;

  // Counting of frames, to allow the page to determine the framerate of dynamic
  // textures.
  bool has_unrendered_update_;
  int last_render_frame_count_;
  int update_count_;
  int render_count_;

  O3D_DECL_CLASS(Texture, ParamObject);
  DISALLOW_COPY_AND_ASSIGN(Texture);
};

class ParamTexture : public TypedRefParam<Texture> {
 public:
  typedef SmartPointer<ParamTexture> Ref;

  ParamTexture(ServiceLocator* service_locator, bool dynamic, bool read_only)
      : TypedRefParam<Texture>(service_locator, dynamic, read_only) {}

 private:
  friend class IClassManager;
  static ObjectBase::Ref Create(ServiceLocator* service_locator);

  O3D_DECL_CLASS(ParamTexture, RefParamBase);
  DISALLOW_COPY_AND_ASSIGN(ParamTexture);
};

}  // namespace o3d

#endif  // O3D_CORE_CROSS_TEXTURE_BASE_H_