Urho
1.0.0.0
Urho.UrhoObject
%Resource cache subsystem. Loads resources on demand and stores them for later access.
To be added.
Constructor
1.0.0.0
Constructs a new instance of Urho.Resources.ResourceCache which is tied to the .
Constructor
1.0.0.0
Pointer to the raw unmanaged Urho object.
Constructs a new instance of Urho.Resources.ResourceCache, given a raw pointer to an unmanaged object
This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.
Objects that are created in this fashion get registered with the UrhoSharp runtime.
This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.
Constructor
1.0.0.0
The context that this object will be attached to.
Constructs a new instance of Urho.Resources.ResourceCache linked to a specific .
Constructor
1.0.0.0
Pass UrhoObjectFlag.Empty.
Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.
This constructor should be invoked by your code if you provide your own constructor that sets the handle field.
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.
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.
Method
1.0.0.0
System.Boolean
To be added.
Add a manually created resource. Must be uniquely named.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
To be added.
Add a package file for loading resources from by name. Optional priority parameter which will control search order.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
To be added.
Add a package file for loading resources from. Optional priority parameter which will control search order.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
To be added.
Add a resource load directory. Optional priority parameter which will control search order.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
Add a resource router object. By default there is none, so the routing process is skipped.
To be added.
Property
1.0.0.0
System.Boolean
Return whether automatic resource reloading is enabled.
Or
Enable or disable automatic reloading of resources as files are modified. Default false.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
To be added.
To be added.
To be added.
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.
To be added.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
Return whether a file exists by name.
To be added.
To be added.
Event
1.0.0.0
System.Action<Urho.Resources.FileChangedEventArgs>
To be added.
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 method. That one will force that callback and will ignore any previously set events here.
Property
1.0.0.0
System.Int32
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.
To be added.
To be added.
Method
1.0.0.0
Urho.Animation
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Urho2D.AnimationSet2D
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.Resource
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.IO.File
To be added.
To be added.
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.
To be added.
To be added.
Method
1.0.0.0
Urho.Gui.Font
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.Image
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.JsonFile
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Material
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.UInt64
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.UInt64
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Model
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.ObjectAnimation
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.ParticleEffect
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Urho2D.ParticleEffect2D
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.PListFile
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.String
To be added.
Return either the path itself or its parent, based on which of them has recognized resource subdirectories.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.Resource
To be added.
To be added.
To be added.
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.
To be added.
To be added.
Method
1.0.0.0
System.String
To be added.
Return full absolute file name of resource if possible.
To be added.
To be added.
Method
1.0.0.0
Urho.ResourceRouter
To be added.
Return a resource router by index.
To be added.
To be added.
Method
1.0.0.0
Urho.Shader
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Audio.Sound
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Urho2D.Sprite2D
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Urho2D.SpriteSheet2D
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Technique
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.Resource
To be added.
To be added.
To be added.
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.)
To be added.
To be added.
Method
1.0.0.0
Urho.Urho2D.Texture2D
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Urho2D.TmxFile2D
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.ValueAnimation
To be added.
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
Urho.Resources.XmlFile
To be added.
To be added.
To be added.
To be added.
To be added.
Event
1.0.0.0
System.Action<Urho.Resources.LoadFailedEventArgs>
To be added.
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 method. That one will force that callback and will ignore any previously set events here.
Property
1.0.0.0
System.UInt32
Return number of pending background-loaded resources.
To be added.
To be added.
Property
1.0.0.0
System.Collections.Generic.IReadOnlyList<Urho.IO.PackageFile>
Return added package files.
To be added.
To be added.
Method
1.0.0.0
System.String
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
Release all resources. When called with the force flag false, releases all currently unused resources.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
Release a resource by name.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
Release resources of all types by partial name.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
Release all resources of a specific type.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
Release resources of a specific type and partial name.
To be added.
Method
1.0.0.0
System.Boolean
To be added.
Reload a resource. Return true on success. The resource will not be removed from the cache in case of failure.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
Reload a resource based on filename. Causes also reload of dependent resources if necessary.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
Remove a package file by name. Optionally release the resources loaded from it.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
Remove a package file. Optionally release the resources loaded from it.
To be added.
Method
1.0.0.0
System.Void
To be added.
Remove a resource load directory.
To be added.
Method
1.0.0.0
System.Void
To be added.
Remove a resource router object.
To be added.
Method
1.0.0.0
System.Void
To be added.
Reset dependencies for a resource.
To be added.
Event
1.0.0.0
System.Action<Urho.Resources.ResourceBackgroundLoadedEventArgs>
To be added.
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 method. That one will force that callback and will ignore any previously set events here.
Event
1.0.0.0
System.Action<Urho.Resources.ResourceNotFoundEventArgs>
To be added.
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 method. That one will force that callback and will ignore any previously set events here.
Property
1.0.0.0
System.Boolean
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.
To be added.
To be added.
Method
1.0.0.0
System.String
To be added.
Remove unnecessary constructs from a resource directory name and ensure it to be an absolute path.
To be added.
To be added.
Method
1.0.0.0
System.String
To be added.
Remove unsupported constructs from the resource name to prevent ambiguity, and normalize absolute filename to resource path relative if possible.
To be added.
To be added.
Property
1.0.0.0
System.Boolean
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.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
To be added.
To be added.
Method
1.0.0.0
System.Void
To be added.
To be added.
Store a dependency for a resource. If a dependency file changes, the resource will be reloaded.
To be added.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the FileChanged event raised by the ResourceCache (single subscriber).
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the LoadFailed event raised by the ResourceCache.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the ResourceBackgroundLoaded event raised by the ResourceCache.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the ResourceNotFound event raised by the ResourceCache.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Method
1.0.0.0
Urho.Subscription
The handler to invoke when this event is raised.
Subscribes to the UnknownResourceType event raised by the ResourceCache.
Returns an Urho.Subscription that can be used to cancel the subscription.
This method will override any prior subscription, including those assigned to on event handlers.
This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.
For a more event-like approach, use the event.
Property
1.0.0.0
System.UInt64
Return total memory use for all resources.
To be added.
To be added.
Property
1.0.0.0
Urho.StringHash
Urho's type system type.
StringHash representing the type for this C# type.
This returns the Urho's type and is surfaced for low-level Urho code.
Property
1.0.0.0
System.String
Urho's low-level type name.
Stringified low-level type name.
Property
1.0.0.0
System.String
Urho's low-level type name, accessible as a static method.
Stringified low-level type name.
Property
1.0.0.0
Urho.StringHash
Urho's low-level type, accessible as a static method.
This returns the Urho's type and is surface for the low-level Urho code.
Event
1.0.0.0
System.Action<Urho.Resources.UnknownResourceTypeEventArgs>
To be added.
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 method. That one will force that callback and will ignore any previously set events here.