# Outline

## Enable

Local enable/disable for the outline. When disabled after being enabled, a clear pass will be done once on the underlying render target and it will no longer be rendered to until enabled again.

## Name

The desired name for your outline. This is used for underlying asset but also for referencing in the plugin. 

## Outline Type

Which kind of outline you want to create:

* Simple -  for a basic, 2px edge detection type outline
* Distance Field - this generates a distance field for more complex outline effects 

## Source

This is a struct whose settings relate to where the data for outline creation comes from. The two available sources are the depth/stencil buffer and any render target you choose.

## Update Rate

Sometimes in order squeeze out more performance, you might want more control over when something is rendered so you can reduce the load at any given time. The update rate settings allow you to choose how frequently the outlines get rendered.

## Scaling

The easiest way to improve performance for outline creation is to reduce the scaling however it can be a bit more nuanced than simply scaling down so you might need more control over this.

## Distance Field

{% hint style="info" %}
Only shows when the [Outline Type](#outline-type) is set to Distance Field
{% endhint %}

These settings provide various optimisations that can make distance field creation much more feasible.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sweenus987.gitbook.io/distance-field-outline/advanced/settings/outline.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.