osu/osu.Game/Skinning/ISkin.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

60 lines
2.4 KiB
C#
Raw Normal View History

2019-04-25 08:36:17 +00:00
// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
2022-03-23 15:08:01 +00:00
#nullable enable
2019-04-25 08:36:17 +00:00
using osu.Framework.Audio.Sample;
using osu.Framework.Bindables;
2019-04-25 08:36:17 +00:00
using osu.Framework.Graphics;
2020-07-17 07:54:30 +00:00
using osu.Framework.Graphics.OpenGL.Textures;
2019-04-25 08:36:17 +00:00
using osu.Framework.Graphics.Textures;
2019-08-23 11:32:43 +00:00
using osu.Game.Audio;
2019-04-25 08:36:17 +00:00
namespace osu.Game.Skinning
{
/// <summary>
/// Provides access to skinnable elements.
/// </summary>
public interface ISkin
{
2019-09-03 09:30:22 +00:00
/// <summary>
/// Retrieve a <see cref="Drawable"/> component implementation.
/// </summary>
/// <param name="component">The requested component.</param>
/// <returns>A drawable representation for the requested component, or null if unavailable.</returns>
2022-03-23 15:08:01 +00:00
Drawable? GetDrawableComponent(ISkinComponent component);
2019-04-25 08:36:17 +00:00
2019-09-03 09:30:22 +00:00
/// <summary>
/// Retrieve a <see cref="Texture"/>.
/// </summary>
/// <param name="componentName">The requested texture.</param>
/// <returns>A matching texture, or null if unavailable.</returns>
2022-03-23 15:08:01 +00:00
Texture? GetTexture(string componentName) => GetTexture(componentName, default, default);
2020-07-17 07:54:30 +00:00
/// <summary>
/// Retrieve a <see cref="Texture"/>.
/// </summary>
/// <param name="componentName">The requested texture.</param>
/// <param name="wrapModeS">The texture wrap mode in horizontal direction.</param>
/// <param name="wrapModeT">The texture wrap mode in vertical direction.</param>
/// <returns>A matching texture, or null if unavailable.</returns>
2022-03-23 15:08:01 +00:00
Texture? GetTexture(string componentName, WrapMode wrapModeS, WrapMode wrapModeT);
2019-04-25 08:36:17 +00:00
2019-09-03 09:30:22 +00:00
/// <summary>
/// Retrieve a <see cref="SampleChannel"/>.
/// </summary>
/// <param name="sampleInfo">The requested sample.</param>
/// <returns>A matching sample channel, or null if unavailable.</returns>
2022-03-23 15:08:01 +00:00
ISample? GetSample(ISampleInfo sampleInfo);
2019-04-25 08:36:17 +00:00
2019-09-03 09:30:22 +00:00
/// <summary>
/// Retrieve a configuration value.
/// </summary>
/// <param name="lookup">The requested configuration value.</param>
/// <returns>A matching value boxed in an <see cref="IBindable{TValue}"/>, or null if unavailable.</returns>
2022-03-25 06:53:55 +00:00
IBindable<TValue>? GetConfig<TLookup, TValue>(TLookup lookup)
where TLookup : notnull
where TValue : notnull;
2019-04-25 08:36:17 +00:00
}
}