/usr/include/opencollada/COLLADAStreamWriter/COLLADASWSampler.h is in opencollada-dev 0.1.0~20140703.ddf8f47+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | /*
Copyright (c) 2008-2009 NetAllied Systems GmbH
This file is part of COLLADAStreamWriter.
Licensed under the MIT Open Source License,
for details please see LICENSE file or the website
http://www.opensource.org/licenses/mit-license.php
*/
#ifndef __COLLADASTREAMWRITER_SAMPLER_H__
#define __COLLADASTREAMWRITER_SAMPLER_H__
#include "COLLADASWPrerequisites.h"
#include "COLLADASWStreamWriter.h"
#include "COLLADASWExtraTechnique.h"
#include "COLLADASWConstants.h"
#include "COLLADASWColor.h"
#include "COLLADASWAnnotation.h"
namespace COLLADASW
{
/** Declares the storage for the graphical representation of an object.
In COLLADA 1.4 parts of this are represented in the <surface> element. It supports
only init_from images. For other inits the surface class might be used in future.*/
class Sampler : public BaseExtraTechnique
{
public:
static const String SAMPLER_SID_SUFFIX;
static const String SURFACE_SID_SUFFIX;
public:
/** The different sampler types. */
enum SamplerType
{
SAMPLER_TYPE_UNSPECIFIED,
SAMPLER_TYPE_1D,
SAMPLER_TYPE_2D,
SAMPLER_TYPE_3D,
SAMPLER_TYPE_CUBE,
SAMPLER_TYPE_RECT,
SAMPLER_TYPE_DEPTH,
SAMPLER_TYPE_STATE
};
/** Contains the texture filter functions.*/
enum SamplerFilter
{
SAMPLER_FILTER_UNSPECIFIED,
SAMPLER_FILTER_NONE,
SAMPLER_FILTER_NEAREST,
SAMPLER_FILTER_LINEAR,
SAMPLER_FILTER_NEAREST_MIPMAP_NEAREST,
SAMPLER_FILTER_LINEAR_MIPMAP_NEAREST,
SAMPLER_FILTER_NEAREST_MIPMAP_LINEAR,
SAMPLER_FILTER_LINEAR_MIPMAP_LINEAR
};
/**
Contains the texture wrap modes.
Wrap modes that affect the interpretation of s, t, and p texture
coordinates in <sampler_*> elements. The wrap mode enums map to the
following OpenGL symbols.*/
enum WrapMode
{
WRAP_MODE_UNSPECIFIED=0,
// NONE == GL_CLAMP_TO BORDER The defined behavior for NONE is
// consistent with decal texturing where the border is black.
// Mapping this calculation to GL_CLAMP_TO_BORDER is the best
// approximation of this.
WRAP_MODE_NONE,
// WRAP == GL_REPEAT Ignores the integer part of texture coordinates,
// using only the fractional part.
WRAP_MODE_WRAP,
// MIRROR == GL_MIRRORED_REPEAT First mirrors the texture coordinate.
// The mirrored coordinate is then clamped as described for CLAMP_TO_EDGE.
WRAP_MODE_MIRROR,
// CLAMP == GL_CLAMP_TO_EDGE Clamps texture coordinates at all
// mipmap levels such that the texture filter never samples a
// border texel. Note: GL_CLAMP takes any texels beyond the
// sampling border and substitutes those texels with the border
// color. So CLAMP_TO_EDGE is more appropriate. This also works
// much better with OpenGL ES where the GL_CLAMP symbol was removed
// from the OpenGL ES specification.
WRAP_MODE_CLAMP,
// BORDER GL_CLAMP_TO_BORDER Clamps texture coordinates at all
// MIPmaps such that the texture filter always samples border
// texels for fragments whose corresponding texture coordinate
// is sufficiently far outside the range [0, 1].
WRAP_MODE_BORDER
};
private:
/** The type of the current sampler. */
SamplerType mSamplerType;
/** An xs:NCName, which is the sid of a <surface>. A <sampler*> is a
definition of how a shader will resolve a color out of a <surface>.
<source> identifies the <surface> to read. */
// String mSource;
/** Texture minimization. Enumerated type fx_sampler_filter_common.
Applying a texture to a primitive implies a mapping from texture image
space to framebuffer image space. In general, this mapping involves
a reconstruction of the sampled texture image, followed by a
homogeneous warping implied by the mapping to framebuffer space, then a
filtering, followed finally by a resampling of the filtered, warped,
reconstructed image before applying it to a fragment. */
SamplerFilter mMinFilter;
/** Texture magnification. Enumerated type fx_sampler_filter_common.
When gamma indicates magnification, this value determines how the
texture value is obtained. */
SamplerFilter mMagFilter;
/** MIPmap filter. Enumerated type fx_sampler_filter_common. */
SamplerFilter mMipFilter;
/** Wrap modes */
WrapMode mWrap_s;
WrapMode mWrap_t;
WrapMode mWrap_p;
/** When reading past the edge of the texture address space based on
the wrap modes involving clamps, this color takes over. Type
fx_color_common (four floating-point numbers in RGBA order). */
Color mBorderColor;
bool mUseBorderColor;
/** An xs:unsignedByte, which is the maximum number of progressive
levels that the sampler will evaluate. */
unsigned char mMipmapMaxlevel;
/** An xs:float, which biases the gamma (level of detail parameter)
that is used by the sampler to evaluate the MIPmap chain. */
float mMipmapBias;
/** The id of the image used for the sampler. Other samplers are not supported
In COLALDA 1.4 this is written in to a surface element, in 1.5 in a sampler element.*/
String mImageId;
/** The format of the current surface.
Contains a string representing the texel format for this
surface. If this element is not specified or understood by
the application, then the application will attempt to use
<format_hint> if it is provided; otherwise, it should
use a common format linear R8G8B8A8.
Only used in COLLADA 1.4. In COLLADA 1.5 this information is contained int h eimage*/
String mFormat;
/** The sid of the sampler. */
String mSamplerSid;
/** The sid of the surface. */
String mSurfaceSid;
public:
/** Constructor. */
Sampler (
const SamplerType& samplerType,
const String& samplerSid,
const String& surfaceSid = "" );
/**Constructor that creates an invalid surface.*/
Sampler();
/** Initialize the members in depend on the sampler type. */
void initializeMembers();
/** Destructor. */
virtual ~Sampler () {}
/** Set the samplers type. */
void setSamplerType ( const SamplerType& val ) { mSamplerType = val; }
/** Returns the samplers type. */
SamplerType getSamplerType() const { return mSamplerType; }
/** The sid of the sampler. */
const COLLADASW::String& getSamplerSid () const { return mSamplerSid; }
/** The sid of the surface. */
const COLLADASW::String& getSurfaceSid () const { return mSurfaceSid; }
/** The image format. */
const COLLADASW::String& getFormat() const { return mFormat; }
void setFormat( const COLLADASW::String& format) { mFormat = format; }
#if 0
/** An xs:NCName, which is the sid of a <surface>. A <sampler*> is a
definition of how a shader will resolve a color out of a <surface>.
<source> identifies the <surface> to read. */
const String& getSource () const;
void setSource ( const String& val );
#endif
/** The URL of the image used for the sampler. Other samplers are not supported
In COLALDA 1.4 this is written in to a surface element, in 1.5 in a sampler element.*/
const COLLADASW::String& getImageUrl() const { return mImageId; }
/** The id of the image used for the sampler. Other samplers are not supported
In COLALDA 1.4 this is written in to a surface element, in 1.5 in a sampler element.*/
void setImageId( const COLLADASW::String& imageId) { mImageId = imageId; }
/** Sets the min filter. */
void setMinFilter ( const SamplerFilter& filter );
/** Returns min filter*/
const SamplerFilter& getMinFilter() const;
/** Sets the mag filter. */
void setMagFilter ( const SamplerFilter& filter );
/** Returns mag filter*/
const SamplerFilter& getMagFilter() const;
/** Sets the mip filter. */
void setMipFilter ( const SamplerFilter& filter );
/** Returns mip filter*/
const SamplerFilter& getMipFilter() const;
/** Retrieves the wrap mode (in dimension S, T or P) of the sampler.
@return The wrap mode.*/
const WrapMode& getWrapS() const;
/** Retrieves the wrap mode (in dimension S, T or P) of the sampler.
@return The wrap mode.*/
const WrapMode& getWrapT() const;
/** Retrieves the wrap mode (in dimension S, T or P) of the sampler.
@return The wrap mode.*/
const WrapMode& getWrapP() const;
/** Sets the wrap mode (in dimension S, T or P) of the sampler.
@param mode The wrap mode.*/
void setWrapS ( const WrapMode& mode );
/** Sets the wrap mode (in dimension S, T or P) of the sampler.
@param mode The wrap mode.*/
void setWrapT ( const WrapMode& mode );
/** Sets the wrap mode (in dimension S, T or P) of the sampler.
@param mode The wrap mode.*/
void setWrapP ( const WrapMode& mode );
/** When reading past the edge of the texture address space based on
the wrap modes involving clamps, this color takes over. Type
fx_color_common (four floating-point numbers in RGBA order). */
const Color& getBorderColor () const;
void setBorderColor ( const Color& val );
/** An xs:unsignedByte, which is the maximum number of progressive
levels that the sampler will evaluate. */
const unsigned char getMipmapMaxlevel () const;
void setMipmapMaxlevel ( const unsigned char val );
/** An xs:float, which biases the gamma (level of detail parameter)
that is used by the sampler to evaluate the MIPmap chain. */
const float getMipmapBias () const;
void setMipmapBias ( const float val );
/** Returns the COLLADASW string for the given sampler type. */
static const String& getSamplerTypeString ( const SamplerType &samplerType );
/** Returns the COLLADASW string for the given surface type (which is identical to the sampler type).*/
const String& getSurfaceTypeString ( SamplerType surfaceType ) const;
/** Returns a reference to the COLLADASW name of the SamplerFilter. */
static const String& getSamplerFilterString ( const SamplerFilter &samplerFilter );
/** Returns a reference to the COLLADASW name of the wrap mode. */
static const String& getWrapModeString ( const WrapMode &wrapMode );
/** Declares the storage for the graphical representation of an object. */
// void add ( StreamWriter *sw ) const;
void addInSetParam(
StreamWriter* sw,
std::vector<COLLADASW::Annotation>* surfaceAnnotations = 0,
std::vector<COLLADASW::Annotation>* samplerAnnotations = 0 ) const;
void addInNewParam(
StreamWriter* sw,
std::vector<COLLADASW::Annotation>* surfaceAnnotations = 0,
std::vector<COLLADASW::Annotation>* samplerAnnotations = 0 ) const;
private:
void addCommon ( StreamWriter* sw ) const;
void add_1_4_1 ( StreamWriter* sw, const String& source ) const;
void add_1_5_0 ( StreamWriter* sw ) const;
template<class ParamSurfaceType, class ParamSamplerType>
void addInParam (
StreamWriter* sw,
std::vector<COLLADASW::Annotation>* surfaceAnnotations = 0,
std::vector<COLLADASW::Annotation>* samplerAnnotations = 0 ) const;
void addSurface ( StreamWriter* sw ) const;
};
}
#endif // __COLLADASTREAMWRITER_SAMPLER_H__
|