Texture Studio

Texture Studio has a simple API for interacting with the Maps and changing its values etc. Below are the currently available methods for the CompositeMap as well as the Layers it contains.

Composite Map Class

public Layer CreateLayer()

Call this to add a blank new layer to the Map.

Returns: Returns a new Layer.

public RenderTexture GetTexture()

Returns the built texture as a RenderTexture.

Returns: Returns the fully built Map as a RenderTexture.

public void UpdateTexture()

Rebuilds the map with the current set values.

public void CreateMapTexture(int width, int height, bool mipmaps = false, bool linear = false)

Rebuilds the map with the texture params passed in. To get the resulting map use the GetTexture() method after calling this.

• width - Width of the final texture.
• height - Height of the final texture
• mipmaps - Whether to create mipmaps
• linear - Is the map to be in linear space

public Layer FindLayer(string name)

Looks through the layers of the map for one called in the passed in name, if finds one it will be returned.

Returns: Returns the Layer if matching name is found else null.

public Layer FindLayerPath(string path)

This will find a layer by path through the hierarchy, so for example if you called this with 'Skins/War Paint/Tatoo' it will look through the base layers for a layer called 'Skins' then check its children for a layer called 'War Paint' and then finally look for a child layer called 'Tatoo'.

You need to use the '/' and the search is case insensitive.

public void SetParam(string param, Vector2 val)

public void SetParam(string param, string val)

public void SetParam(string param, float val)

public void SetParam(string param, bool val)

public void SetParam(string param, int val)

public void SetParam(string param, Texture val)

public void SetParam(string param, Color val)

public void SetParam(string param, ReplaceColor rcol, int index)

These methods are used to change the values of any params on the layers. When making the call all the layers of the map will be checked for any param that matches the passed in param name, if any are found their values are updated with the passed in value. There are numerous different types depending on the value type being passed in. Below is a list of the current Params that can be changed and the expected value type to use to change its value.

• Active - bool, true to turn on, false for off
• Angle - Float, value is in degrees
• Bend - Float, value is in degrees
• Blend - Texture
• BlendAmount - Float, 0-1
• BlendMode - String, name of the BlendMode to set
• FontSize - Float
• Map - Texture
• Mask - Texture
• OutlineWidth - Float
• OutlineCol - Color
• SpriteIndex - Int
• Tint - Color
• Text - String
• TextAlign - String, TMPro TextAlign enum name
• TextCol - Color
• TextStyle - String, TMPro Text Style enum name
• TextObj - GameObject, TMPro prefab
• UseMask - bool
• ReplaceColors - ReplaceColor and an int index
• Position - Vector2
• Scale - Vector2
• Contrast - Float
• Saturation - Float

public bool GetColourReplace(string layer, int index, ref ReplaceColor col)

Will return in the ReplaceColor col param the replace color info for the layer and index passed in. The index value is a value 0-8 for the replace color to return.

• layer - The name of the layer to get the color replace from
• index - the index of the replace color to get
• col - on return will contain the color replace info

This will return true if the layer is found, false if no layer found.

public bool SetColourReplace(string layer, int index, ReplaceColor col)

This can be used to change a color replace value on a layer. It will look for the Layer with the name, and set the replace color whose index is passed in to the values in the ReplaceColor col passed in.

• layer - The name of the layer to set the color replace from
• index - The index of the replace color to set
• col - New values for this color
• to - The new To color value

This will return true if the layer is found, false if no layer found.

public List<Layer> GetAllLayers()

Calling this will return a List of all the layers the map contains, the returned list will be in the order the layers are applied to the map.

public Texture2D CreateTexture(TSize width, TSize height)

Calling this will return a new Texture2D object made from the final map result, you pass in a Width and Height value for the new texture.

public void SetParent(Layer layer, Layer parent)

Sets the parent of the layer passed in to the parent value, this allows you to remove layers and reorder them as needed.

public bool SetLayerTransform(string name, Vector2 pos, float angle, Vector2 scale)

Will set the layer whose name is passed transform to pos, angle and scale.

Will return true if the layer has been positioned false if no layer matching the passed name is found.

public bool GetLayerTransform(string name, ref Vector2 pos, ref float angle, ref Vector2 scale)

Will return in pos, angle and scale the transform of the layer whose is passed in.

Will return true if the layer was found and false if no match for name is found.

Below is a list of the public values in the CompositeMap class and what they control:

public List<Layer> layers;

The list of all base Layers, each Layer also has a list of its child Layers so this is not a complete List of all the layers for the map. Use the GetAllLayers() method if you want all the layers in the map.

public TSize width;

The width of the map.

public TSize height;

The height of the map.

public bool square;

Whether the map is square. If this is set the width value will also be the height value.

public bool srgb;

Is the Texture srgb.

public bool mipMaps;

Should mipmaps be made for the map.

public MapMode mapMode;

Whether the map is a Texture or a Normal map.

public Texture2D LUT;

Color LUT texture. 32x32 Format.

public float LUTAmount;

How much the LUT is applied.

public float hue;

Hue value for the map.

public float saturation;

Saturation value for the map.

public float contrast;

Contrast value for the map.

public float brightness;

Brightness value for the map.

public float levelsMin;

Min Levels value for the map.

public float levelsMax;

Max Levels value for the map.

public RenderTexture outputTexture;

A target render texture to send the end result to.

public bool adjustOutput;

Whether final map should use color adjustments.

Public values in the Layer class.

public string name;

Name of the layer, used by Find methods. Each name should be unique.

public bool active;

Is the layer used in the end map.

public Texture map;

Texture for this layer.

public bool useMask;

Should the layer use the mask value or any parent mask.

public Texture mask;

Mask texture for this layer.

public MaskChannel maskChannel;

The channel of the mask texture to use.

public Sprite sprite;

The Sprite to use for this layer.

public Texture blend;

Texture used to blend the layer to the map.

public MaskChannel blendChannel;

The channel to control the blending.

public Vector3 pos;

The position of the layer in map.

public Vector2 scale;

Scale of the layer in the map.

public float angle;

Rotation of the layer in the map.

public Color tint;

Color tint for the layer.

public float remapLow;

Low value to remap the colors to.

public float remapHigh;

High Value to remap the colors to.

public float multiply;

Multiple the colors by this value.

public float remapLowAlpha;

Low Remap value for the Alpha channel.

public float remapHighAlpha;

High remap value for the Alpha channel.

public Swizzle swizzleR;

The Swizzle option for the red channel.

public Swizzle swizzleG;

The Swizzle option for the green channel.

public Swizzle swizzleB;

The swizzle option for the blue channel.

public Swizzle swizzleA;

The swizzle option for the alpha channel.

public bool atlas;

Is the Map a texture atlas.

public int columns;

If an atlas the number of columns in the atlas.

public int rows;

If an atlas the number of rows in the atlas.

public Vector2 mapOff;

Map Texture UV offset value.

public Vector2 mapTile;

Map Texture UV Tile value.

public Vector2 maskOff;

Mask Texture UV Offset value.

public Vector2 maskTile;

Mask Texture UV Tile value.

public GameObject text;

TMPro prefab object to use for the text for this layer.

public string str;

The string to turn to TMPro Text.

public Color textCol;

Color of the text.

public Vector3[] corners;

The corner position in the map for the layer.

public float bend;

How much the bend the layer in degrees.

public AlignPivot align;

Where the pivot is located on the layer.

public List<Layer> children ;

List of any child layers this layer has.

public Layer parent;

The parent layer for this layer.

public BlendMode blendMode;

The Photoshop style blending mode for the layer.

public float blendAmount ;

How much to blend the layer.

public float fontSize;

The size of the font to use for the text.

public FontStyles fontStyle;

The TMPro fontstyle to use.

public TextAlignmentOptions textAlignment;

The TMPro textalignment option for the text.

public float outlineWidth = 0.0f;

The width of any outline.

public Color outlineColor;

The color of the outline.

public int spriteIndex;

If the texture is an atlas or a sprite is set this controls which image is actually displayed.

public TextTSize textTSize;

How much to change the text rendering size by.

public float LUTAmount;

How much to apply the LUT to this layer.

public Texture2D LUT;

The 32x32 format LUT texture.

public float rLevel;

The output level of the red channel.

public float gLevel;

The output level of the green channel.

public float bLevel;

The output level of the blue channel.

public float aLevel;

The output level of the alpha channel.

public float hue;

The layers Hue value.

public float saturation;

The layers saturation value.

public float contrast;

The layers contrast value.

public float brightness;

The layers brightness value.

public float levelsMin;

The layers levels min value.

public float levelsMax;

The layers levels max value.

public ReplaceColor[] replaceColors;

Array of the replace color values.

Some small script snippets to show how to interact with a map, more will be added.

Setting a Map Param

To set a param that has been defined on a Map layer or layers you just need to call the SetParam method with the name of the Param you want to set and the value to set. The param will need to have been added to any layers in the Texture Studio Window. After setting the value the map is told to Update and then finally we set the texture back to the material or materials that are using it.

void ChangeRaceNumber(int number)
{
    map.SetParam("Race Number", number.ToString());
    map.UpdateTexture();
    mat.mainTexture = map.GetTexture();
}

Find A Layer

To find a layer you can either find by the layer name or you can find by a path. To find by a layer name you simply call the FindLayer method with the name of the layer you want and it will be returned if found or null returned if not found.

Layer find = map.FindLayer("Decals);

To find by path you pass in a string containing the path with '/' to separate the layer levels, this can be useful if you map contains multiple layers with the same name but you need a specific layer from the map.

Layer l = map.FindLayerPath("Livery 2/Roundels/Race Number Right");

To make using the Maps easier in your scene a simple MapManager script is included. With this script you can add the maps you are using in the scene to a list and then add a list of materials used by that map and when the scene starts the correct texture will be applied to the materials for you.

Add a new Map for each CompositeMap you plan on using in the scene, set the name of the texture param you want to apply the map to for the material and then add any material you wish to use the texture to the materials list. When the scene runs the materials will be updated with the composite map texture. If you make any changes to the Composite Map at runtime the materials will automatically show the changes.