gfxTextureArray.h

Engine/source/gfx/gfxTextureArray.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GFXTEXTUREARRAY_H_
25#define _GFXTEXTUREARRAY_H_
26
27#ifndef _REFBASE_H_
28#include "core/util/refBase.h"
29#endif
30#ifndef _GFXRESOURCE_H_
31#include "gfx/gfxResource.h"
32#endif
33#ifndef _GFXENUMS_H_
34#include "gfxEnums.h"
35#endif
36#ifndef _GFXTEXTUREHANDLE_H_
37#include "gfxTextureHandle.h"
38#endif
39#include "core/util/tVector.h"
40
41
42class GFXTextureProfile;
43class GFXTextureObject;
44
45class GFXTextureArray : public StrongRefBase, public GFXResource
46{
47public:
48   GFXTextureArray();
49
50   virtual void init() = 0;
51   virtual void set(U32 width, U32 height, U32 size, GFXFormat format, U32 mipLevels = 0);
52   virtual bool fromTextureArray(const Vector<GFXTexHandle> &textureArray, U32 capacity = 0);
53   virtual void setTexture(const GFXTexHandle &texture, U32 slot);
54   virtual void setToTexUnit(U32 tuNum) = 0;
55
56
57   // GFXResource interface
58   virtual void zombify() = 0;
59   virtual void resurrect() = 0;
60   virtual void Release();
61
62   virtual const String describeSelf() const;
63
64   GFXFormat mFormat;
65   bool mIsCompressed;
66   U32 mWidth;
67   U32 mHeight;
68   U32 mArraySize;
69   U32 mMipLevels;
70
71   Vector<GFXTexHandle> mTextures;
72
73protected:
74   virtual void _setTexture(const GFXTexHandle& texture, U32 slot) = 0;
75};
76
77
78/// A reference counted handle to a texture array resource.
79class GFXTextureArrayHandle : public StrongRefPtr<GFXTextureArray>
80{
81public:
82   GFXTextureArrayHandle() {}
83   GFXTextureArrayHandle(GFXTextureArray* textureArray) { StrongRefPtr<GFXTextureArray>::set(textureArray); }
84
85   /// Releases the texture handle.
86   void free() { StrongObjectRef::set(NULL); }
87};
88
89#endif // _GFXTEXTUREARRAY_H_
90