Torque3D Documentation / _generateds / gfxTextureProfile.cpp

gfxTextureProfile.cpp

Engine/source/gfx/gfxTextureProfile.cpp

More...

Public Functions

DefineEngineFunction(getTextureProfileStats , String , () , "Returns <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> list of texture profiles in the format: ProfileName TextureCount <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">TextureMB\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">GFX\n</a>" )

GFX_ImplementTextureProfile(GFXDynamicTextureProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Dynamic , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXDynamicTextureSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Dynamic</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXNormalMapBC3Profile , GFXTextureProfile::NormalMap , GFXTextureProfile::Static , GFXTextureProfile::BC3 )

GFX_ImplementTextureProfile(GFXNormalMapBC5Profile , GFXTextureProfile::NormalMap , GFXTextureProfile::Static , GFXTextureProfile::BC5 )

GFX_ImplementTextureProfile(GFXNormalMapProfile , GFXTextureProfile::NormalMap , GFXTextureProfile::Static , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXRenderTargetProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da75302d480adb239daa0dd3fec9fd7a0b">GFXTextureProfile::RenderTarget , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXRenderTargetSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da75302d480adb239daa0dd3fec9fd7a0b">GFXTextureProfile::RenderTarget</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXStaticTextureProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Static , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXStaticTextureSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Static</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXSystemMemTextureProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da475e6f853f2a13cce818588cc2a57715">GFXTextureProfile::SystemMemory , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXTexturePersistentProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da23d780ef2bcc57521a4945415ce5207f">GFXTextureProfile::Static</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daa6bb823fc92adbec55ba4c34cd586062">GFXTextureProfile::KeepBitmap , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXTexturePersistentSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da23d780ef2bcc57521a4945415ce5207f">GFXTextureProfile::Static</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daa6bb823fc92adbec55ba4c34cd586062">GFXTextureProfile::KeepBitmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXZTargetProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daa3a2027753aec009ced4f0818a231296">GFXTextureProfile::ZTarget</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da80d43e9b398433d953f373496edacc7b">GFXTextureProfile::NoDiscard , GFXTextureProfile::NONE )

Detailed Description
Public Functions
DefineEngineFunction(getTextureProfileStats , String , () , "Returns <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> list of texture profiles in the format: ProfileName TextureCount <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">TextureMB\n</a>" "@ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">GFX\n</a>" )

GFX_ImplementTextureProfile(GFXDynamicTextureProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Dynamic , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXDynamicTextureSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Dynamic</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXNormalMapBC3Profile , GFXTextureProfile::NormalMap , GFXTextureProfile::Static , GFXTextureProfile::BC3 )

GFX_ImplementTextureProfile(GFXNormalMapBC5Profile , GFXTextureProfile::NormalMap , GFXTextureProfile::Static , GFXTextureProfile::BC5 )

GFX_ImplementTextureProfile(GFXNormalMapProfile , GFXTextureProfile::NormalMap , GFXTextureProfile::Static , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXRenderTargetProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da75302d480adb239daa0dd3fec9fd7a0b">GFXTextureProfile::RenderTarget , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXRenderTargetSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da75302d480adb239daa0dd3fec9fd7a0b">GFXTextureProfile::RenderTarget</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXStaticTextureProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Static , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXStaticTextureSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::Static</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXSystemMemTextureProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da475e6f853f2a13cce818588cc2a57715">GFXTextureProfile::SystemMemory , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXTexturePersistentProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da23d780ef2bcc57521a4945415ce5207f">GFXTextureProfile::Static</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daa6bb823fc92adbec55ba4c34cd586062">GFXTextureProfile::KeepBitmap , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXTexturePersistentSRGBProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da23d780ef2bcc57521a4945415ce5207f">GFXTextureProfile::Static</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daa6bb823fc92adbec55ba4c34cd586062">GFXTextureProfile::KeepBitmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf6773a6da8ddf28520016603401b8f23">GFXTextureProfile::SRGB , GFXTextureProfile::NONE )

GFX_ImplementTextureProfile(GFXZTargetProfile , GFXTextureProfile::DiffuseMap , GFXTextureProfile::PreserveSize</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daf55b13e32bd1a1746406b68ead73ba05">GFXTextureProfile::NoMipmap</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82daa3a2027753aec009ced4f0818a231296">GFXTextureProfile::ZTarget</a>|<a href="/coding/class/classgfxtextureprofile/#classgfxtextureprofile_1a09105f0bf717a1f2ae49ceda21b8e82da80d43e9b398433d953f373496edacc7b">GFXTextureProfile::NoDiscard , GFXTextureProfile::NONE )

  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#include "platform/platform.h"
 25#include "gfx/gfxTextureProfile.h"
 26
 27#include "gfx/gfxTextureObject.h"
 28#include "gfx/bitmap/gBitmap.h"
 29#include "core/strings/stringFunctions.h"
 30#include "console/console.h"
 31#include "console/engineAPI.h"
 32
 33
 34// Set up defaults...
 35
 36GFX_ImplementTextureProfile(GFXRenderTargetProfile,
 37                            GFXTextureProfile::DiffuseMap,
 38                            GFXTextureProfile::PreserveSize | GFXTextureProfile::NoMipmap | GFXTextureProfile::RenderTarget,
 39                            GFXTextureProfile::NONE);
 40GFX_ImplementTextureProfile(GFXRenderTargetSRGBProfile,
 41                            GFXTextureProfile::DiffuseMap,
 42                            GFXTextureProfile::PreserveSize | GFXTextureProfile::NoMipmap | GFXTextureProfile::RenderTarget | GFXTextureProfile::SRGB,
 43                            GFXTextureProfile::NONE);
 44GFX_ImplementTextureProfile(GFXStaticTextureProfile, GFXTextureProfile::DiffuseMap,
 45                            GFXTextureProfile::Static,
 46                            GFXTextureProfile::NONE);
 47GFX_ImplementTextureProfile(GFXStaticTextureSRGBProfile,
 48                            GFXTextureProfile::DiffuseMap,
 49                            GFXTextureProfile::Static | GFXTextureProfile::SRGB,
 50                            GFXTextureProfile::NONE);
 51GFX_ImplementTextureProfile(GFXTexturePersistentProfile,
 52                            GFXTextureProfile::DiffuseMap,
 53                            GFXTextureProfile::PreserveSize | GFXTextureProfile::Static | GFXTextureProfile::KeepBitmap,
 54                            GFXTextureProfile::NONE);
 55GFX_ImplementTextureProfile(GFXTexturePersistentSRGBProfile,
 56                            GFXTextureProfile::DiffuseMap,
 57                            GFXTextureProfile::PreserveSize | GFXTextureProfile::Static | GFXTextureProfile::KeepBitmap | GFXTextureProfile::SRGB,
 58                            GFXTextureProfile::NONE);
 59GFX_ImplementTextureProfile(GFXSystemMemTextureProfile,
 60                            GFXTextureProfile::DiffuseMap,
 61                            GFXTextureProfile::PreserveSize | GFXTextureProfile::NoMipmap | GFXTextureProfile::SystemMemory,
 62                            GFXTextureProfile::NONE);
 63GFX_ImplementTextureProfile(GFXNormalMapProfile,
 64                            GFXTextureProfile::NormalMap,
 65                            GFXTextureProfile::Static,
 66                            GFXTextureProfile::NONE);
 67GFX_ImplementTextureProfile(GFXNormalMapBC3Profile,
 68                            GFXTextureProfile::NormalMap,
 69                            GFXTextureProfile::Static,
 70                            GFXTextureProfile::BC3);
 71GFX_ImplementTextureProfile(GFXNormalMapBC5Profile,
 72                            GFXTextureProfile::NormalMap,
 73                            GFXTextureProfile::Static,
 74                            GFXTextureProfile::BC5);
 75GFX_ImplementTextureProfile(GFXZTargetProfile,
 76                            GFXTextureProfile::DiffuseMap,
 77                            GFXTextureProfile::PreserveSize | GFXTextureProfile::NoMipmap | GFXTextureProfile::ZTarget | GFXTextureProfile::NoDiscard,
 78                            GFXTextureProfile::NONE);
 79GFX_ImplementTextureProfile(GFXDynamicTextureProfile,
 80                            GFXTextureProfile::DiffuseMap,
 81                            GFXTextureProfile::Dynamic,
 82                            GFXTextureProfile::NONE);
 83GFX_ImplementTextureProfile(GFXDynamicTextureSRGBProfile,
 84                            GFXTextureProfile::DiffuseMap,
 85                            GFXTextureProfile::Dynamic | GFXTextureProfile::SRGB,
 86                            GFXTextureProfile::NONE);
 87
 88//-----------------------------------------------------------------------------
 89
 90GFXTextureProfile *GFXTextureProfile::smHead = NULL;
 91U32 GFXTextureProfile::smProfileCount = 0;
 92
 93GFXTextureProfile::GFXTextureProfile(const String &name, Types type, U32 flag, Compression compression)
 94:  mName( name )
 95{
 96   // Take type, flag, and compression and produce a munged profile word.
 97   mProfile = (type & (BIT(TypeBits + 1) - 1)) |
 98             ((flag & (BIT(FlagBits + 1) - 1)) << TypeBits) | 
 99             ((compression & (BIT(CompressionBits + 1) - 1)) << (FlagBits + TypeBits));   
100
101   // Stick us on the linked list.
102   mNext = smHead;
103   smHead = this;
104   ++smProfileCount;
105
106   // Now do some sanity checking. (Ben is not proud of this code.)
107   AssertFatal( (testFlag(Dynamic) && !testFlag(Static)) 
108                  || (!testFlag(Dynamic) && !testFlag(Static)) 
109                  || (!testFlag(Dynamic) &&  testFlag(Static)), 
110                  "GFXTextureProfile::GFXTextureProfile - Cannot have a texture profile be both static and dynamic!");
111   mDownscale = 0;
112}
113
114void GFXTextureProfile::init()
115{
116   // Do something, anything?
117}
118
119GFXTextureProfile * GFXTextureProfile::find(const String &name)
120{
121   // Not really necessary at this time.
122   return NULL;
123}
124
125void GFXTextureProfile::collectStats( Flags flags, GFXTextureProfileStats *stats )
126{
127   // Walk the profile list.
128   GFXTextureProfile *curr = smHead;
129   while ( curr )
130   {
131      if ( curr->testFlag( flags ) )
132         (*stats) += curr->getStats();
133
134      curr = curr->mNext;
135   }
136}
137
138void GFXTextureProfile::updateStatsForCreation(GFXTextureObject *t)
139{
140   if(t->mProfile)
141   {
142      t->mProfile->incActiveCopies();
143      t->mProfile->mStats.allocatedTextures++;
144      
145      U32 texSize = t->getHeight() * t->getWidth();
146      U32 byteSize = t->getEstimatedSizeInBytes();
147
148      t->mProfile->mStats.allocatedTexels += texSize;
149      t->mProfile->mStats.allocatedBytes  += byteSize;
150
151      t->mProfile->mStats.activeTexels += texSize;
152      t->mProfile->mStats.activeBytes += byteSize; 
153   }
154}
155
156void GFXTextureProfile::updateStatsForDeletion(GFXTextureObject *t)
157{
158   if(t->mProfile)
159   {
160      t->mProfile->decActiveCopies();
161      
162      U32 texSize = t->getHeight() * t->getWidth();
163      U32 byteSize = t->getEstimatedSizeInBytes();
164
165      t->mProfile->mStats.activeTexels -= texSize;
166      t->mProfile->mStats.activeBytes -= byteSize; 
167   }
168}
169
170DefineEngineFunction( getTextureProfileStats, String, (),,
171   "Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB\n"
172   "@ingroup GFX\n" )
173{
174   StringBuilder result;
175
176   GFXTextureProfile *profile = GFXTextureProfile::getHead();
177   while ( profile )
178   {
179      const GFXTextureProfileStats &stats = profile->getStats();
180
181      F32 mb = ( stats.activeBytes / 1024.0f ) / 1024.0f;
182
183      result.format( "%s %d %0.2f\n",
184         profile->getName().c_str(),
185         stats.activeCount,
186         mb );
187
188      profile = profile->getNext();
189   }
190
191   return result.end();
192}
193
194