API ReferenceSandbox.Resources

ImageFileGeneratorclass

Load images from disk and convert them to textures

objectTextureGeneratorImageFileGenerator
Namespace
Sandbox.Resources
Assembly
Sandbox.Engine
Declaration
public class Sandbox.Resources.ImageFileGenerator : Sandbox.Resources.TextureGenerator

Constructors1

Showing 1 constructors

Methods2

Showing 2 methods

protected virtual System.Threading.Tasks.ValueTask`1<Sandbox.Texture> CreateTexture(Sandbox.Resources.ResourceGenerator.Options options, System.Threading.CancellationToken ct)PROTECTEDVIRTUAL

ParameterTypeDescription
optionsOptions
ctCancellationToken
Returns:ValueTask<Texture>

Properties21

Showing 21 properties

public float Sandbox.Resources.ImageFileGenerator.Blur { get; set; }PUBLICGETSET

The intensity of the blur effect. If 0, no blur is applied.

Returns:float

public float Sandbox.Resources.ImageFileGenerator.Brightness { get; set; }PUBLICGETSET

The brightness of the image.

Returns:float

public virtual bool Sandbox.Resources.ImageFileGenerator.CacheToDisk { get; set; }PUBLICVIRTUALGETSET

Returns:bool

public bool Sandbox.Resources.ImageFileGenerator.Colorize { get; set; }PUBLICGETSET

When enabled, every pixel in the image will be re-colored to the `Sandbox.Resources.ImageFileGenerator.TargetColor` (interpolated by the alpha).

Returns:bool

public float Sandbox.Resources.ImageFileGenerator.Contrast { get; set; }PUBLICGETSET

The contrast of the image.

Returns:float

public bool Sandbox.Resources.ImageFileGenerator.ConvertHeightToNormals { get; set; }PUBLICGETSET

When enabled, the output texture will be a normal map generated from the heightmap of the image.

Returns:bool

public Sandbox.UI.Margin Sandbox.Resources.ImageFileGenerator.Cropping { get; set; }PUBLICGETSET

How many pixels from each edge to crop from the image. If negative values are used, the image will be expanded instead of cropped.

Returns:Margin

public string Sandbox.Resources.ImageFileGenerator.FilePath { get; set; }PUBLICGETSET

The path to the image file, relative to any other assets in the project.

Returns:string

public bool Sandbox.Resources.ImageFileGenerator.FlipHorizontal { get; set; }PUBLICGETSET

Whether or not to flip the image horizontally. This is done after everything else has been applied.

Returns:bool

public bool Sandbox.Resources.ImageFileGenerator.FlipVertical { get; set; }PUBLICGETSET

Whether or not to flip the image vertically. This is done after everything else has been applied.

Returns:bool

public float Sandbox.Resources.ImageFileGenerator.Hue { get; set; }PUBLICGETSET

How much to adjust the hue of the image, in degrees. If 0, no hue adjustment is applied.

Returns:float

public bool Sandbox.Resources.ImageFileGenerator.InvertColor { get; set; }PUBLICGETSET

Whether or not to invert the colors of the image.

Returns:bool

public int Sandbox.Resources.ImageFileGenerator.MaxSize { get; set; }PUBLICGETSET

The maximum size of the image in pixels. If the imported image is larger than this (after cropping), it will be downscaled to fit.

Returns:int

public float Sandbox.Resources.ImageFileGenerator.NormalScale { get; set; }PUBLICGETSET

The scale of the normal map when using `Sandbox.Resources.ImageFileGenerator.ConvertHeightToNormals`. If negative, the normal map will be inverted.

Returns:float

public Sandbox.UI.Margin Sandbox.Resources.ImageFileGenerator.Padding { get; set; }PUBLICGETSET

How many pixels of padding from each edge. After the image has been cropped, padding is added without affecting the size of the image (scaling the original image down to fit padded margins).

Returns:Margin

public float Sandbox.Resources.ImageFileGenerator.Rotate { get; set; }PUBLICGETSET

How much to rotate the image by, in degrees. This is applied after cropping and padding.

Returns:float

public float Sandbox.Resources.ImageFileGenerator.Saturation { get; set; }PUBLICGETSET

The saturation of the image.

Returns:float

public float Sandbox.Resources.ImageFileGenerator.Sharpen { get; set; }PUBLICGETSET

The intensity of the sharpen effect. If 0, no sharpening is applied.

Returns:float

public Color Sandbox.Resources.ImageFileGenerator.TargetColor { get; set; }PUBLICGETSET

When `Sandbox.Resources.ImageFileGenerator.Colorize` is enabled, this is the target color that every pixel in the image will be re-colored to.

Returns:Color

public Color Sandbox.Resources.ImageFileGenerator.Tint { get; set; }PUBLICGETSET

The color the image should be tinted. This effectively multiplies the color of each pixel by this color (including alpha).

Returns:Color

On this page

Constructorspublic ImageFileGenerator()Methodspublic virtual System.Nullable`1<Sandbox.Resources.EmbeddedResource> CreateEmbeddedResource()protected virtual System.Threading.Tasks.ValueTask`1<Sandbox.Texture> CreateTexture(Sandbox.Resources.ResourceGenerator.Options options, System.Threading.CancellationToken ct)Propertiespublic System.Single Sandbox.Resources.ImageFileGenerator.Blur { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.Brightness { get; set; }public virtual System.Boolean Sandbox.Resources.ImageFileGenerator.CacheToDisk { get; set; }public System.Boolean Sandbox.Resources.ImageFileGenerator.Colorize { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.Contrast { get; set; }public System.Boolean Sandbox.Resources.ImageFileGenerator.ConvertHeightToNormals { get; set; }public Sandbox.UI.Margin Sandbox.Resources.ImageFileGenerator.Cropping { get; set; }public System.String Sandbox.Resources.ImageFileGenerator.FilePath { get; set; }public System.Boolean Sandbox.Resources.ImageFileGenerator.FlipHorizontal { get; set; }public System.Boolean Sandbox.Resources.ImageFileGenerator.FlipVertical { get; set; }public virtual System.Nullable`1<Sandbox.ImageFormat> Sandbox.Resources.ImageFileGenerator.FormatOverride { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.Hue { get; set; }public System.Boolean Sandbox.Resources.ImageFileGenerator.InvertColor { get; set; }public System.Int32 Sandbox.Resources.ImageFileGenerator.MaxSize { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.NormalScale { get; set; }public Sandbox.UI.Margin Sandbox.Resources.ImageFileGenerator.Padding { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.Rotate { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.Saturation { get; set; }public System.Single Sandbox.Resources.ImageFileGenerator.Sharpen { get; set; }public Color Sandbox.Resources.ImageFileGenerator.TargetColor { get; set; }public Color Sandbox.Resources.ImageFileGenerator.Tint { get; set; }Metadata