| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907 |
- <Type Name="ResourceCache" FullName="Urho.Resources.ResourceCache">
- <TypeSignature Language="C#" Value="public class ResourceCache : Urho.UrhoObject" />
- <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ResourceCache extends Urho.UrhoObject" />
- <AssemblyInfo>
- <AssemblyName>Urho</AssemblyName>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Base>
- <BaseTypeName>Urho.UrhoObject</BaseTypeName>
- </Base>
- <Interfaces />
- <Docs>
- <summary>
- %Resource cache subsystem. Loads resources on demand and stores them for later access.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- <Members>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="public ResourceCache ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
- <MemberType>Constructor</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <Parameters />
- <Docs>
- <summary>
- <para>Constructs a new instance of Urho.Resources.ResourceCache which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
- </summary>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="public ResourceCache (IntPtr handle);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
- <MemberType>Constructor</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <Parameters>
- <Parameter Name="handle" Type="System.IntPtr" />
- </Parameters>
- <Docs>
- <param name="handle">Pointer to the raw unmanaged Urho object.</param>
- <summary>Constructs a new instance of Urho.Resources.ResourceCache, given a raw pointer to an unmanaged object</summary>
- <remarks>
- <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
- <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
- <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="public ResourceCache (Urho.Context context);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
- <MemberType>Constructor</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <Parameters>
- <Parameter Name="context" Type="Urho.Context" />
- </Parameters>
- <Docs>
- <param name="context">The context that this object will be attached to.</param>
- <summary>
- <para>Constructs a new instance of Urho.Resources.ResourceCache linked to a specific <see cref="T:Urho.Context" />.</para>
- </summary>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName=".ctor">
- <MemberSignature Language="C#" Value="protected ResourceCache (Urho.UrhoObjectFlag emptyFlag);" />
- <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
- <MemberType>Constructor</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <Parameters>
- <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
- </Parameters>
- <Docs>
- <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
- <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
- <remarks>
- <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
- <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
- <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="AddManualResource">
- <MemberSignature Language="C#" Value="public bool AddManualResource (Urho.Resources.Resource resource);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool AddManualResource(class Urho.Resources.Resource resource) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="resource" Type="Urho.Resources.Resource" />
- </Parameters>
- <Docs>
- <param name="resource">To be added.</param>
- <summary>
- Add a manually created resource. Must be uniquely named.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="AddPackageFile">
- <MemberSignature Language="C#" Value="public bool AddPackageFile (string fileName, uint priority);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool AddPackageFile(string fileName, unsigned int32 priority) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="fileName" Type="System.String" />
- <Parameter Name="priority" Type="System.UInt32" />
- </Parameters>
- <Docs>
- <param name="fileName">To be added.</param>
- <param name="priority">To be added.</param>
- <summary>
- Add a package file for loading resources from by name. Optional priority parameter which will control search order.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="AddPackageFile">
- <MemberSignature Language="C#" Value="public bool AddPackageFile (Urho.IO.PackageFile package, uint priority);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool AddPackageFile(class Urho.IO.PackageFile package, unsigned int32 priority) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="package" Type="Urho.IO.PackageFile" />
- <Parameter Name="priority" Type="System.UInt32" />
- </Parameters>
- <Docs>
- <param name="package">To be added.</param>
- <param name="priority">To be added.</param>
- <summary>
- Add a package file for loading resources from. Optional priority parameter which will control search order.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="AddResourceDir">
- <MemberSignature Language="C#" Value="public bool AddResourceDir (string pathName, uint priority);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool AddResourceDir(string pathName, unsigned int32 priority) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="pathName" Type="System.String" />
- <Parameter Name="priority" Type="System.UInt32" />
- </Parameters>
- <Docs>
- <param name="pathName">To be added.</param>
- <param name="priority">To be added.</param>
- <summary>
- Add a resource load directory. Optional priority parameter which will control search order.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="AddResourceRouter">
- <MemberSignature Language="C#" Value="public void AddResourceRouter (Urho.ResourceRouter router, bool addAsFirst = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddResourceRouter(class Urho.ResourceRouter router, bool addAsFirst) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="router" Type="Urho.ResourceRouter" />
- <Parameter Name="addAsFirst" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="router">To be added.</param>
- <param name="addAsFirst">To be added.</param>
- <summary>
- Add a resource router object. By default there is none, so the routing process is skipped.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="AutoReloadResources">
- <MemberSignature Language="C#" Value="public bool AutoReloadResources { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool AutoReloadResources" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return whether automatic resource reloading is enabled.
- Or
- Enable or disable automatic reloading of resources as files are modified. Default false.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="BackgroundLoadResource">
- <MemberSignature Language="C#" Value="public bool BackgroundLoadResource (Urho.StringHash type, string name, bool sendEventOnFailure = true, Urho.Resources.Resource caller = null);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool BackgroundLoadResource(valuetype Urho.StringHash type, string name, bool sendEventOnFailure, class Urho.Resources.Resource caller) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- <Parameter Name="caller" Type="Urho.Resources.Resource" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <param name="caller">To be added.</param>
- <summary>
- Background load a resource. An event will be sent when complete. Return true if successfully stored to the load queue, false if eg. already exists. Can be called from outside the main thread.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Exists">
- <MemberSignature Language="C#" Value="public bool Exists (string name);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Exists(string name) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="name">To be added.</param>
- <summary>
- Return whether a file exists by name.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="FileChanged">
- <MemberSignature Language="C#" Value="public event Action<Urho.Resources.FileChangedEventArgs> FileChanged;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Resources.FileChangedEventArgs> FileChanged" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Resources.FileChangedEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToFileChanged" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="FinishBackgroundResourcesMs">
- <MemberSignature Language="C#" Value="public int FinishBackgroundResourcesMs { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance int32 FinishBackgroundResourcesMs" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Int32</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return how many milliseconds maximum to spend on finishing background loaded resources.
- Or
- Set how many milliseconds maximum per frame to spend on finishing background loaded resources.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetAnimation">
- <MemberSignature Language="C#" Value="public Urho.Animation GetAnimation (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Animation GetAnimation(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Animation</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetAnimationSet2D">
- <MemberSignature Language="C#" Value="public Urho.Urho2D.AnimationSet2D GetAnimationSet2D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Urho2D.AnimationSet2D GetAnimationSet2D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Urho2D.AnimationSet2D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetExistingResource">
- <MemberSignature Language="C#" Value="public Urho.Resources.Resource GetExistingResource (Urho.StringHash type, string name);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.Resource GetExistingResource(valuetype Urho.StringHash type, string name) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.Resource</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="name" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="type">Type signature for the resource type to load.</param>
- <param name="name">Name of the resource to load</param>
- <summary>Fetches an already loaded resource of specific type and name.</summary>
- <returns>Returns ther resoruce, or <see langword="null" /> if not found. </returns>
- <remarks>Will not load if does not exist.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetFile">
- <MemberSignature Language="C#" Value="public Urho.IO.File GetFile (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.IO.File GetFile(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.IO.File</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">To be added.</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>
- Open and return a file from the resource load paths or from inside a package file. If not found, use a fallback search with absolute path. Return null if fails. Can be called from outside the main thread.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetFont">
- <MemberSignature Language="C#" Value="public Urho.Gui.Font GetFont (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Gui.Font GetFont(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Gui.Font</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">To be added.</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>Fetches a font stored as a resource.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetImage">
- <MemberSignature Language="C#" Value="public Urho.Resources.Image GetImage (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.Image GetImage(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.Image</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>Loads an image resource by name. </summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetJsonFile">
- <MemberSignature Language="C#" Value="public Urho.Resources.JsonFile GetJsonFile (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.JsonFile GetJsonFile(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.JsonFile</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetMaterial">
- <MemberSignature Language="C#" Value="public Urho.Material GetMaterial (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Material GetMaterial(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Material</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetMemoryBudget">
- <MemberSignature Language="C#" Value="public ulong GetMemoryBudget (Urho.StringHash type);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int64 GetMemoryBudget(valuetype Urho.StringHash type) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.UInt64</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetMemoryUse">
- <MemberSignature Language="C#" Value="public ulong GetMemoryUse (Urho.StringHash type);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int64 GetMemoryUse(valuetype Urho.StringHash type) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.UInt64</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetModel">
- <MemberSignature Language="C#" Value="public Urho.Model GetModel (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Model GetModel(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Model</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetObjectAnimation">
- <MemberSignature Language="C#" Value="public Urho.ObjectAnimation GetObjectAnimation (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.ObjectAnimation GetObjectAnimation(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.ObjectAnimation</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetParticleEffect">
- <MemberSignature Language="C#" Value="public Urho.ParticleEffect GetParticleEffect (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.ParticleEffect GetParticleEffect(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.ParticleEffect</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetParticleEffect2D">
- <MemberSignature Language="C#" Value="public Urho.Urho2D.ParticleEffect2D GetParticleEffect2D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Urho2D.ParticleEffect2D GetParticleEffect2D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Urho2D.ParticleEffect2D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetPListFile">
- <MemberSignature Language="C#" Value="public Urho.Resources.PListFile GetPListFile (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.PListFile GetPListFile(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.PListFile</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetPreferredResourceDir">
- <MemberSignature Language="C#" Value="public string GetPreferredResourceDir (string path);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetPreferredResourceDir(string path) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="path" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="path">To be added.</param>
- <summary>
- Return either the path itself or its parent, based on which of them has recognized resource subdirectories.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetResource">
- <MemberSignature Language="C#" Value="public Urho.Resources.Resource GetResource (Urho.StringHash type, string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.Resource GetResource(valuetype Urho.StringHash type, string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.Resource</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="type">Type signature for the resource type to load.</param>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>
- Return a resource by type and name. Load if not loaded yet. Return null if not found or if fails, unless SetReturnFailedResources(true) has been called. Can be called only from the main thread.
- </summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetResourceFileName">
- <MemberSignature Language="C#" Value="public string GetResourceFileName (string name);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetResourceFileName(string name) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource.</param>
- <summary>
- Return full absolute file name of resource if possible.
- </summary>
- <returns>The full path name, or an empty string if the resource name does not exist in any of the registered resource directories.</returns>
- <remarks>
- <para>To be added.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetResourceRouter">
- <MemberSignature Language="C#" Value="public Urho.ResourceRouter GetResourceRouter (uint index);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.ResourceRouter GetResourceRouter(unsigned int32 index) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.ResourceRouter</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="index" Type="System.UInt32" />
- </Parameters>
- <Docs>
- <param name="index">To be added.</param>
- <summary>
- Return a resource router by index.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetShader">
- <MemberSignature Language="C#" Value="public Urho.Shader GetShader (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Shader GetShader(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Shader</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetSound">
- <MemberSignature Language="C#" Value="public Urho.Audio.Sound GetSound (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Audio.Sound GetSound(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Audio.Sound</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetSprite2D">
- <MemberSignature Language="C#" Value="public Urho.Urho2D.Sprite2D GetSprite2D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Urho2D.Sprite2D GetSprite2D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Urho2D.Sprite2D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetSpriteSheet2D">
- <MemberSignature Language="C#" Value="public Urho.Urho2D.SpriteSheet2D GetSpriteSheet2D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Urho2D.SpriteSheet2D GetSpriteSheet2D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Urho2D.SpriteSheet2D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetTechnique">
- <MemberSignature Language="C#" Value="public Urho.Technique GetTechnique (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Technique GetTechnique(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Technique</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetTempResource">
- <MemberSignature Language="C#" Value="public Urho.Resources.Resource GetTempResource (Urho.StringHash type, string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.Resource GetTempResource(valuetype Urho.StringHash type, string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.Resource</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>
- Load a resource without storing it in the resource cache. Return null if not found or if fails. Can be called from outside the main thread if the resource itself is safe to load completely (it does not possess for example GPU data.)
- </summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="GetTexture2D">
- <MemberSignature Language="C#" Value="public Urho.Urho2D.Texture2D GetTexture2D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Urho2D.Texture2D GetTexture2D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Urho2D.Texture2D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>Loads a 2D Texture resource by name. </summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetTexture3D">
- <MemberSignature Language="C#" Value="public Urho.Texture3D GetTexture3D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Texture3D GetTexture3D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Texture3D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>Loads a 3D Texture resource by name. </summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetTextureCube">
- <MemberSignature Language="C#" Value="public Urho.Texture GetTextureCube (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Texture GetTextureCube(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Texture</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>Loads a Texture Cube resource by name. </summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetTmxFile2D">
- <MemberSignature Language="C#" Value="public Urho.Urho2D.TmxFile2D GetTmxFile2D (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Urho2D.TmxFile2D GetTmxFile2D(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Urho2D.TmxFile2D</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetValueAnimation">
- <MemberSignature Language="C#" Value="public Urho.ValueAnimation GetValueAnimation (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.ValueAnimation GetValueAnimation(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.ValueAnimation</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="GetXmlFile">
- <MemberSignature Language="C#" Value="public Urho.Resources.XmlFile GetXmlFile (string name, bool sendEventOnFailure = true);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Resources.XmlFile GetXmlFile(string name, bool sendEventOnFailure) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.Resources.XmlFile</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="sendEventOnFailure" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="name">Name of the resource to load</param>
- <param name="sendEventOnFailure">If <see langword="true" /> this raises the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</param>
- <summary>To be added.</summary>
- <returns>
- <see langword="null" /> if not found, or if there is an error. Unless <see cref="P:Urho.Resources.ResourceCache.ReturnFailedResources" /> has been set to <see langword="true" />.</returns>
- <remarks>
- <para>It loads the resource if it has not been loaded yet.</para>
- <para>
- </para>
- <para>Should only be called from the main thread.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="LoadFailed">
- <MemberSignature Language="C#" Value="public event Action<Urho.Resources.LoadFailedEventArgs> LoadFailed;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Resources.LoadFailedEventArgs> LoadFailed" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Resources.LoadFailedEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToLoadFailed" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="NumBackgroundLoadResources">
- <MemberSignature Language="C#" Value="public uint NumBackgroundLoadResources { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance unsigned int32 NumBackgroundLoadResources" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.UInt32</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return number of pending background-loaded resources.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="PackageFiles">
- <MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<Urho.IO.PackageFile> PackageFiles { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class Urho.IO.PackageFile> PackageFiles" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Collections.Generic.IReadOnlyList<Urho.IO.PackageFile></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return added package files.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="PrintMemoryUsage">
- <MemberSignature Language="C#" Value="public string PrintMemoryUsage ();" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string PrintMemoryUsage() cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Parameters />
- <Docs>
- <summary>Returns a formatted string containing the memory actively used.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReleaseAllResources">
- <MemberSignature Language="C#" Value="public void ReleaseAllResources (bool force = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReleaseAllResources(bool force) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="force" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="force">To be added.</param>
- <summary>
- Release all resources. When called with the force flag false, releases all currently unused resources.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReleaseResource">
- <MemberSignature Language="C#" Value="public void ReleaseResource (Urho.StringHash type, string name, bool force = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReleaseResource(valuetype Urho.StringHash type, string name, bool force) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="name" Type="System.String" />
- <Parameter Name="force" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <param name="name">To be added.</param>
- <param name="force">To be added.</param>
- <summary>
- Release a resource by name.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReleaseResources">
- <MemberSignature Language="C#" Value="public void ReleaseResources (string partialName, bool force = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReleaseResources(string partialName, bool force) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="partialName" Type="System.String" />
- <Parameter Name="force" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="partialName">To be added.</param>
- <param name="force">To be added.</param>
- <summary>
- Release resources of all types by partial name.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReleaseResources">
- <MemberSignature Language="C#" Value="public void ReleaseResources (Urho.StringHash type, bool force = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReleaseResources(valuetype Urho.StringHash type, bool force) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="force" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <param name="force">To be added.</param>
- <summary>
- Release all resources of a specific type.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReleaseResources">
- <MemberSignature Language="C#" Value="public void ReleaseResources (Urho.StringHash type, string partialName, bool force = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReleaseResources(valuetype Urho.StringHash type, string partialName, bool force) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="partialName" Type="System.String" />
- <Parameter Name="force" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <param name="partialName">To be added.</param>
- <param name="force">To be added.</param>
- <summary>
- Release resources of a specific type and partial name.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReloadResource">
- <MemberSignature Language="C#" Value="public bool ReloadResource (Urho.Resources.Resource resource);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool ReloadResource(class Urho.Resources.Resource resource) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="resource" Type="Urho.Resources.Resource" />
- </Parameters>
- <Docs>
- <param name="resource">To be added.</param>
- <summary>
- Reload a resource. Return true on success. The resource will not be removed from the cache in case of failure.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ReloadResourceWithDependencies">
- <MemberSignature Language="C#" Value="public void ReloadResourceWithDependencies (string fileName);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ReloadResourceWithDependencies(string fileName) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="fileName" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="fileName">To be added.</param>
- <summary>
- Reload a resource based on filename. Causes also reload of dependent resources if necessary.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="RemovePackageFile">
- <MemberSignature Language="C#" Value="public void RemovePackageFile (string fileName, bool releaseResources = true, bool forceRelease = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemovePackageFile(string fileName, bool releaseResources, bool forceRelease) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="fileName" Type="System.String" />
- <Parameter Name="releaseResources" Type="System.Boolean" />
- <Parameter Name="forceRelease" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="fileName">To be added.</param>
- <param name="releaseResources">To be added.</param>
- <param name="forceRelease">To be added.</param>
- <summary>
- Remove a package file by name. Optionally release the resources loaded from it.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="RemovePackageFile">
- <MemberSignature Language="C#" Value="public void RemovePackageFile (Urho.IO.PackageFile package, bool releaseResources = true, bool forceRelease = false);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemovePackageFile(class Urho.IO.PackageFile package, bool releaseResources, bool forceRelease) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="package" Type="Urho.IO.PackageFile" />
- <Parameter Name="releaseResources" Type="System.Boolean" />
- <Parameter Name="forceRelease" Type="System.Boolean" />
- </Parameters>
- <Docs>
- <param name="package">To be added.</param>
- <param name="releaseResources">To be added.</param>
- <param name="forceRelease">To be added.</param>
- <summary>
- Remove a package file. Optionally release the resources loaded from it.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="RemoveResourceDir">
- <MemberSignature Language="C#" Value="public void RemoveResourceDir (string pathName);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveResourceDir(string pathName) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="pathName" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="pathName">To be added.</param>
- <summary>
- Remove a resource load directory.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="RemoveResourceRouter">
- <MemberSignature Language="C#" Value="public void RemoveResourceRouter (Urho.ResourceRouter router);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveResourceRouter(class Urho.ResourceRouter router) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="router" Type="Urho.ResourceRouter" />
- </Parameters>
- <Docs>
- <param name="router">To be added.</param>
- <summary>
- Remove a resource router object.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ResetDependencies">
- <MemberSignature Language="C#" Value="public void ResetDependencies (Urho.Resources.Resource resource);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ResetDependencies(class Urho.Resources.Resource resource) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="resource" Type="Urho.Resources.Resource" />
- </Parameters>
- <Docs>
- <param name="resource">To be added.</param>
- <summary>
- Reset dependencies for a resource.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="ResourceBackgroundLoaded">
- <MemberSignature Language="C#" Value="public event Action<Urho.Resources.ResourceBackgroundLoadedEventArgs> ResourceBackgroundLoaded;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Resources.ResourceBackgroundLoadedEventArgs> ResourceBackgroundLoaded" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Resources.ResourceBackgroundLoadedEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToResourceBackgroundLoaded" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="ResourceNotFound">
- <MemberSignature Language="C#" Value="public event Action<Urho.Resources.ResourceNotFoundEventArgs> ResourceNotFound;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Resources.ResourceNotFoundEventArgs> ResourceNotFound" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Resources.ResourceNotFoundEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Event raised by any of the Get resource methods if the requested resource is not found.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToResourceNotFound" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="ReturnFailedResources">
- <MemberSignature Language="C#" Value="public bool ReturnFailedResources { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool ReturnFailedResources" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return whether resources that failed to load are returned.
- Or
- Enable or disable returning resources that failed to load. Default false. This may be useful in editing to not lose resource ref attributes.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SanitateResourceDirName">
- <MemberSignature Language="C#" Value="public string SanitateResourceDirName (string name);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string SanitateResourceDirName(string name) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="name">To be added.</param>
- <summary>
- Remove unnecessary constructs from a resource directory name and ensure it to be an absolute path.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SanitateResourceName">
- <MemberSignature Language="C#" Value="public string SanitateResourceName (string name);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string SanitateResourceName(string name) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="name" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="name">To be added.</param>
- <summary>
- Remove unsupported constructs from the resource name to prevent ambiguity, and normalize absolute filename to resource path relative if possible.
- </summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SearchPackagesFirst">
- <MemberSignature Language="C#" Value="public bool SearchPackagesFirst { get; set; }" />
- <MemberSignature Language="ILAsm" Value=".property instance bool SearchPackagesFirst" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Boolean</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return whether when getting resources should check package files or directories first.
- Or
- Define whether when getting resources should check package files or directories first. True for packages, false for directories.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SetMemoryBudget">
- <MemberSignature Language="C#" Value="public void SetMemoryBudget (Urho.StringHash type, ulong budget);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetMemoryBudget(valuetype Urho.StringHash type, unsigned int64 budget) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="type" Type="Urho.StringHash" />
- <Parameter Name="budget" Type="System.UInt64" />
- </Parameters>
- <Docs>
- <param name="type">To be added.</param>
- <param name="budget">To be added.</param>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="StoreResourceDependency">
- <MemberSignature Language="C#" Value="public void StoreResourceDependency (Urho.Resources.Resource resource, string dependency);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void StoreResourceDependency(class Urho.Resources.Resource resource, string dependency) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Void</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="resource" Type="Urho.Resources.Resource" />
- <Parameter Name="dependency" Type="System.String" />
- </Parameters>
- <Docs>
- <param name="resource">To be added.</param>
- <param name="dependency">To be added.</param>
- <summary>
- Store a dependency for a resource. If a dependency file changes, the resource will be reloaded.
- </summary>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToFileChanged">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToFileChanged (Action<Urho.Resources.FileChangedEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToFileChanged(class System.Action`1<valuetype Urho.Resources.FileChangedEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.FileChanged += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Resources.FileChangedEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the FileChanged event raised by the ResourceCache (single subscriber).</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Resources.ResourceCache.FileChanged" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToLoadFailed">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToLoadFailed (Action<Urho.Resources.LoadFailedEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToLoadFailed(class System.Action`1<valuetype Urho.Resources.LoadFailedEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.LoadFailed += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Resources.LoadFailedEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the LoadFailed event raised by the ResourceCache.</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Resources.ResourceCache.LoadFailed" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToResourceBackgroundLoaded">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToResourceBackgroundLoaded (Action<Urho.Resources.ResourceBackgroundLoadedEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToResourceBackgroundLoaded(class System.Action`1<valuetype Urho.Resources.ResourceBackgroundLoadedEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ResourceBackgroundLoaded += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Resources.ResourceBackgroundLoadedEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the ResourceBackgroundLoaded event raised by the ResourceCache.</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Resources.ResourceCache.ResourceBackgroundLoaded" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToResourceNotFound">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToResourceNotFound (Action<Urho.Resources.ResourceNotFoundEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToResourceNotFound(class System.Action`1<valuetype Urho.Resources.ResourceNotFoundEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.ResourceNotFound += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Resources.ResourceNotFoundEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the ResourceNotFound event raised by the ResourceCache.</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Resources.ResourceCache.ResourceNotFound" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="SubscribeToUnknownResourceType">
- <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToUnknownResourceType (Action<Urho.Resources.UnknownResourceTypeEventArgs> handler);" />
- <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToUnknownResourceType(class System.Action`1<valuetype Urho.Resources.UnknownResourceTypeEventArgs> handler) cil managed" />
- <MemberType>Method</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.UnknownResourceType += ...' instead.")</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.Subscription</ReturnType>
- </ReturnValue>
- <Parameters>
- <Parameter Name="handler" Type="System.Action<Urho.Resources.UnknownResourceTypeEventArgs>" />
- </Parameters>
- <Docs>
- <param name="handler">The handler to invoke when this event is raised.</param>
- <summary>Subscribes to the UnknownResourceType event raised by the ResourceCache.</summary>
- <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
- <remarks>
- <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
- <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
- <para>For a more event-like approach, use the <see cref="E:Urho.Resources.ResourceCache.UnknownResourceType" /> event.</para>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="TotalMemoryUse">
- <MemberSignature Language="C#" Value="public ulong TotalMemoryUse { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance unsigned int64 TotalMemoryUse" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.UInt64</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>
- Return total memory use for all resources.
- </summary>
- <value>To be added.</value>
- <remarks>To be added.</remarks>
- </Docs>
- </Member>
- <Member MemberName="Type">
- <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>Urho.StringHash</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's type system type.</summary>
- <value>StringHash representing the type for this C# type.</value>
- <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
- </Docs>
- </Member>
- <Member MemberName="TypeName">
- <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
- <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's low-level type name.</summary>
- <value>Stringified low-level type name.</value>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="TypeNameStatic">
- <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
- <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.String</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's low-level type name, accessible as a static method.</summary>
- <value>Stringified low-level type name.</value>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="TypeStatic">
- <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
- <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
- <MemberType>Property</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <Attributes>
- <Attribute>
- <AttributeName>Preserve</AttributeName>
- </Attribute>
- </Attributes>
- <ReturnValue>
- <ReturnType>Urho.StringHash</ReturnType>
- </ReturnValue>
- <Docs>
- <summary>Urho's low-level type, accessible as a static method.</summary>
- <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
- <remarks>
- </remarks>
- </Docs>
- </Member>
- <Member MemberName="UnknownResourceType">
- <MemberSignature Language="C#" Value="public event Action<Urho.Resources.UnknownResourceTypeEventArgs> UnknownResourceType;" />
- <MemberSignature Language="ILAsm" Value=".event class System.Action`1<valuetype Urho.Resources.UnknownResourceTypeEventArgs> UnknownResourceType" />
- <MemberType>Event</MemberType>
- <AssemblyInfo>
- <AssemblyVersion>1.0.0.0</AssemblyVersion>
- </AssemblyInfo>
- <ReturnValue>
- <ReturnType>System.Action<Urho.Resources.UnknownResourceTypeEventArgs></ReturnType>
- </ReturnValue>
- <Docs>
- <summary>To be added.</summary>
- <remarks>
- <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToUnknownResourceType" /> method. That one will force that callback and will ignore any previously set events here.</para>
- </remarks>
- </Docs>
- </Member>
- </Members>
- </Type>
|