InstaMAT

https://docs.instamat.io
Admin
InstaMAT is a suite of next-generation 3D texture and asset creation tools and SDKs designed for...
Tokens:91,059
Snippets:941
Trust Score:5.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Execute graph with file:// resource parameters

Source: https://docs.instamat.io/Products/InstaMAT_Pipeline

Loads a Font and a Background image from the C:/ drive using the file:// prefix. The command extends the previous example by adding file-based resources as input parameters.

```text
InstaMATPipeline -mode Execute -graph Text 1024 1024" -parameter FontSize 0.2 -parameter HorizontalAlignment 1 -parameter Text "\"InstaMAT\nis\namazing\"" -compositionParameter Levels Output "Luminance In" "[ 0.0 0.6 0.8 ]" -parameter Background "file://C:/Image.png" -parameter Font "file://C:/Font.ttf"
```

--------------------------------

### VisEx parenthesis example

Source: https://docs.instamat.io/Products/InstaMAT_Studio/Canvas/Visibility_Expressions

Shows how to use parentheses to define logical order in a VisEx expression. Note that a space is required before and after the ( and ) characters.

```text
Mode == 0 || ( Mode == 1 && StepCount > 0 )
```

--------------------------------

### Execute graph with composition parameter

Source: https://docs.instamat.io/Products/InstaMAT_Pipeline

Extends the previous example by adding a Levels composition node. The Output of the graph is connected to the RGBIn input of the Levels node, and its input parameter is set to the vector [0.0 0.6 0.8].

```text
InstaMATPipeline -mode Execute -graph Text 1024 1024 -parameter Seed 1005 -parameter FontSize 0.2 -parameter HorizontalAlignment 1 -parameter Text "\"InstaMAT\nis\namazing\"" -compositionParameter Levels Output "RGBIn" "[ 0.0 0.6 0.8 ]"
```

--------------------------------

### VisEx logical operator chaining examples

Source: https://docs.instamat.io/Products/InstaMAT_Studio/Canvas/Visibility_Expressions

Two example VisEx expressions that chain conditions with logical operators. The first combines a vector component comparison with an equality check using &&; the second uses || to allow either condition. Both are valid only when the parameter name is on the left side of the operator.

```text
Resolution.X > 10 && StepCount == 5
```

```text
Mode == 0 || Mode == 2
```

--------------------------------

### Initialize InstaMAT SDK with GPU backend

Source: https://docs.instamat.io/Products/InstaMAT_C%2B%2B_SDK

Initializes the InstaMAT SDK with GPU backend and no plugins. If initialization fails, an error message is printed to stderr. The SDK is hardware-accelerated and executes on the graphics card; a software backend fallback is available on Windows if no GPU is present.

```cpp
if (!instaMAT->Initialize(IInstaMAT::BackendTypeGPU, IInstaMAT::BackendFlagNoPlugins))
{
    fprintf(stderr, "ERROR: Failed to initialize InstaMAT.\n");
}

```

--------------------------------

### VisEx combined water level and shore wetness example

Source: https://docs.instamat.io/Products/InstaMAT_Studio/Canvas/Visibility_Expressions

Makes a parameter visible only when both WaterLevel is greater than 0 and WaterLevelShoreWetness is greater than or equal to 0.50 (50%).

```text
WaterLevel > 0.00 && WaterLevelShoreWetness >= 0.50
```

--------------------------------

### Execute graph with CPU backend using -software

Source: https://docs.instamat.io/Products/InstaMAT_Pipeline

Executes a graph using the CPU execution backend on machines without a graphics card. The -software argument enables CPU execution instead of GPU.

```text
InstaMATPipeline -software -mode Execute -graph "ArcPavement" 1024 1024
```

--------------------------------

### Exclude graph from unit testing with -excludeGraph

Source: https://docs.instamat.io/Products/InstaMAT_Pipeline

Excludes the graph with GraphID "53e7ba3e-29ca-4673-8830-93f8307bbcc3" from unit testing. The example excludes the graph "Brick Wall Painted Red".

```text
InstaMATPipeline -mode UnitTest -env "Environment/" -outputFolder "Reference/" -excludeGraph "53e7ba3e-29ca-4673-8830-93f8307bbcc3"
```

--------------------------------

### Create or load a package with -mode Package

Source: https://docs.instamat.io/Products/InstaMAT_Pipeline

Generates a package named 'TestPackage.IMP' in the directory 'C:\Packages'. If a package exists at the specified path, it is loaded instead.

```text
InstaMATPipeline -mode Package "/Packages/TestPackage.IMP"
```

--------------------------------

### VisEx water level visibility example

Source: https://docs.instamat.io/Products/InstaMAT_Studio/Canvas/Visibility_Expressions

Makes a parameter visible when the WaterLevel parameter is greater than 0. The parameter stays invisible while WaterLevel is 0% and becomes visible as soon as the water level increases.

```text
WaterLevel > 0.00
```

--------------------------------

### Authorize InstaMAT machine with AuthorizeMachine

Source: https://docs.instamat.io/Products/InstaMAT_C%2B%2B_SDK

Authorize the workstation using your license credentials. If authorization fails, an error is printed and the function returns. On success, the current license information and host authorization status are printed to stdout.

```cpp
if (!instaMAT->AuthorizeMachine("username", "password"))
{
    fprintf(stderr, "ERROR: Failed to acquire license:\n%s\n", instaMAT->GetAuthorizationInformation());
    return;
}

// output current license information to console
fprintf(stdout, "%s\n", instaMAT->GetAuthorizationInformation());
fprintf(stdout, "Is host authorized: %s\n", instaMAT->IsHostAuthorized() ? "YES" : "NO");
```
Tokens:
Raw