s&box docs
API ReferenceSandbox.Resources

public class Sandbox.Resources.ImageFileGenerator : Sandbox.Resources.TextureGenerator

Load images from disk and convert them to textures

Constructors

Showing 1 constructors

Methods

Showing 2 methods

public 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)

Properties

Showing 20 properties

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

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

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

The brightness of the image.

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

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

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

The contrast of the image.

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

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

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

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

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

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

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

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

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

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

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

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

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

Whether or not to invert the colors of the image.

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

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

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

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

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

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).

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

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

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

The saturation of the image.

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

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

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

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

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

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

Metadata

FieldValue
NamespaceSandbox.Resources
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.Resources.ImageFileGenerator

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 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