[page:Material] →

# [name]

Un materiale renderizzato con shader personalizzati. Uno shader è un piccolo programma scritto in [link:https://www.khronos.org/files/opengles_shading_language.pdf GLSL] che viene eseguito sulla GPU. Potresti voler utilizzare uno shader personalizzato se hai bisogno di:

- implementare un effetto non incluso in nessuno dei [page:Material materiali] incorporati
- combinare più oggetti in una singola [page:BufferGeometry] per migliorare le prestazioni

Di seguito ci sono delle informazioni da tenere a mente quando si utilizza uno `ShaderMaterial`:

- Uno `ShaderMaterial` sarà renderizzato corretamente solo da [page:WebGLRenderer], poiché il codice GLSL nelle proprietà [link:https://en.wikipedia.org/wiki/Shader#Vertex_shaders vertexShader] e [link:https://en.wikipedia.org/wiki/Shader#Pixel_shaders fragmentShader] deve essere compilato ed eseguito sulla GPU utilizzando WebGL.
- A partire da THREE r72, l'assegnazione diretta di attributi in uno ShaderMaterial non è più supportata. È invece necessario utilizzare un'istanza di [page:BufferGeometry], utilizzando le istanze [page:BufferAttribute] per definire gli attributi personalizzati.
- A partire da THREE r77, le istanze [page:WebGLRenderTarget] o [page:WebGLCubeRenderTarget] non devono essere più utilizzate come uniformi. Al loro posto è necessario utilizzare la loro proprietà [page:Texture texture].
- Gli attributi e le uniformi integrati vengono passati agli shader insieme al codice. Se non vuoi che [page:WebGLProgram] aggiunga nulla al tuo codice shader, puoi usare [page:RawShaderMaterial] invece di questa classe.
- È possibile utilizzare la direttiva #pragma unroll_loop_start e #pragma unroll_loop_end per srotolare un ciclo `for` in GLSL dal preprocessore dello shader. La direttiva deve essere posizionata proprio sopra il cilo. La formattazione del ciclo deve corrispondere a uno standard definito.
  - Il loop deve essere [link:https://en.wikipedia.org/wiki/Normalized_loop normalizzato].
  - La variabile del loop deve essere *i*.
  - Il valore `UNROLLED_LOOP_INDEX` sarà sostituito con il valore esplicito di *i* per l'iterazione data e può essere utilizzato nelle istruzioni del preprocessore.
  `#pragma unroll_loop_start for ( int i = 0; i < 10; i ++ ) { // ... } #pragma unroll_loop_end`

## Codice di Esempio

`const material = new THREE.ShaderMaterial( { uniforms: { time: { value: 1.0 }, resolution: { value: new THREE.Vector2() } }, vertexShader: document.getElementById( 'vertexShader' ).textContent, fragmentShader: document.getElementById( 'fragmentShader' ).textContent } );`

## Esempi

[example:webgl_buffergeometry_custom_attributes_particles webgl / buffergeometry / custom / attributes / particles]
[example:webgl_buffergeometry_selective_draw webgl / buffergeometry / selective / draw]
[example:webgl_custom_attributes webgl / custom / attributes]
[example:webgl_custom_attributes_lines webgl / custom / attributes / lines]
[example:webgl_custom_attributes_points webgl / custom / attributes / points]
[example:webgl_custom_attributes_points2 webgl / custom / attributes / points2]
[example:webgl_custom_attributes_points3 webgl / custom / attributes / points3]
[example:webgl_depth_texture webgl / depth / texture]
[example:webgl_gpgpu_birds webgl / gpgpu / birds]
[example:webgl_gpgpu_protoplanet webgl / gpgpu / protoplanet]
[example:webgl_gpgpu_water webgl / gpgpu / water]
[example:webgl_interactive_points webgl / interactive / points]
[example:webgl_video_kinect webgl / video / kinect]
[example:webgl_lights_hemisphere webgl / lights / hemisphere]
[example:webgl_marchingcubes webgl / marchingcubes]
[example:webgl_materials_envmaps webgl / materials / envmaps]
[example:webgl_materials_wireframe webgl / materials / wireframe]
[example:webgl_modifier_tessellation webgl / modifier / tessellation]
[example:webgl_postprocessing_dof2 webgl / postprocessing / dof2]
[example:webgl_postprocessing_godrays webgl / postprocessing / godrays]

## Vertex shader e fragment shader

Si possono specificare due differenti tipi di shader per ogni materiale:

- Il vertex shader viene eseguito per primo; riceve gli `attributes` (attributi), calcola / manipola la posizione di ogni singolo vertice, e passa valori aggiuntivi (`varying`) al fragment shader.
- Il fragment (o pixel) shader viene eseguito per secondo; imposta il colore di ogni singolo "fragment" (pixel) visualizzato nello schermo.

Ci sono tre tipi di variabili negli shader: uniforms (uniformi), attributes (attributi), e varyings (variazioni):

- `Uniforms` sono variabili che hanno lo stesso valore per tutti i vertici - mappe di illuminazione, nebbia, e mappe di ombreggiatura sono esempi di dati che verrebbero memorizzati nelle variabili uniformi. È possibile accedere a queste varibili sia dal vertex shader sia dal fragment shader.
- `Attributes` sono variabili associate ad ogni vertice; ad esempio, la posizione del vertice, la normale della faccia e il colore del vertice sono tutti esempi di dati che dovrebbero essere memorizzati negli attributi. Si può accedere a queste variabili `solo` dal vertex shader.
- `Varyings` sono variabili che vengono passate da il vertex shader al fragment shader. Per ogni fragment, il valore di ogni variazione sarà interpolato senza problemi dai valori dei vertici adiacenti.

Si noti che `all'interno` dello shader stesso, uniforms e attributes agiscono come costanti; si può solo modificare i loro valori passando valori diversi ai buffer dal codice JavaScript.

## Attributi e uniformi incorporati

Il [page:WebGLRenderer] fornisce da impostazione predefinita molti attributi e uniformi agli shader; le definizioni di queste variabili vengono anteposte al codice `fragmentShader` e `vertexShader` dal [page:WebGLProgram] quando lo shader viene compilato; non è necessario che li dichiari tu stesso. Vedi [page:WebGLProgram] per il dettaglio di queste variabili.

Alcune di queste uniformi o attributi (per esempio quelli relativi all'illuminazione, alla nebbia, etc.) richiedono l'impostazione delle proprietà sul materiale affinché [page:WebGLRenderer] possa copiare i valori appropriati alla GPU - assicurati di impostare questi flag se vuoi utilizzare queste funzionalità nel tuo shader.

Se non vuoi che [page:WebGLProgram] aggiungera niente al tuo codice shader, puoi usare [page:RawShaderMaterial] invece di questa classe.

## Attributi e uniformi personalizzate

Sia gli attributi personalizzati che le uniformi personalizzate devono essere dichiarate nel tuo codice shader GLSL (all'interno di `vertexShader` e/o `fragmentShader`). Le uniformi personalizzate devono essere definite in `entrambe` le proprietà `uniforms` del tuo `ShaderMaterial`, mentre qualsiasi attributo personalizzato deve essere definito tramite le istanze di [page:BufferAttribute]. Si noti che è necessario dichiarare le variazioni solo all'interno del codice shader (non all'iterno del materiale).

Per dichiarare un attributo personalizzato, fare riferimento alla pagina [page:BufferGeometry] per una panoramica, e la pagina [page:BufferAttribute] per uno sguardo dettagliato alle API `BufferAttribute`.

Quando crei i tuoi attributi, ogni array tipizzato che crei per contenere i dati del tuo attributo deve essere multiplo della dimensione del tuo tipo di dati. Per esempio, se il tuo attributo è di tipo [page:Vector3 THREE.Vector3], e hai 3000 vertici nel tuo [page:BufferGeometry], il valore del tuo array tipizzato deve essere creato con una lunghezza di 3000 * 3, o 9000 (un valore per componente). Di seguito viene mostrata una tabella delle dimensioni di ciascun tipo di dati come riferimento:

Dimensioni attributi
Tipo GLSL | Tipo JavaScript | Dimensione
--- | --- | ---
float | [page:Number] | 1
vec2 | [page:Vector2 THREE.Vector2] | 2
vec3 | [page:Vector3 THREE.Vector3] | 3
vec3 | [page:Color THREE.Color] | 3
vec4 | [page:Vector4 THREE.Vector4] | 4

Si noti che i buffer degli attributi `non` vengono aggiornati automaticamente quando i loro valori cambiano. Per aggiornare gli attributi personalizzati, imposta il flag `needsUpdate` a true sul [page:BufferAttribute] della geometria (vedi [page:BufferGeometry] per maggiori dettagli).

Per dichiarare una [page:Uniform] personalizzata, utilizzare la proprietà `uniforms`: `uniforms: { time: { value: 1.0 }, resolution: { value: new THREE.Vector2() } }`

Si consiglia di aggiornare i valori di [page:Uniform] personalizzati in base all'[page:Object3D object] e alla [page:Camera telecamera] in [page:Object3D.onBeforeRender] poiché il [page:Material Materiale] può essere condiviso tra le [page:Mesh mesh], la [page:Matrix4 matrixWorld] della [page:Scene scena] e la [page:Camera telecamera] viene aggiornata in [page:WebGLRenderer.render], e alcuni effetti eseguono il rendering di una scena con le proprie [page:Camera telecamere] private.

## Costruttore

### [name]( [param:Object parameters] )

[page:Object parameters] - (opzionale) un oggetto con una o più proprietà che definiscono l'aspetto del materiale. Qualsiasi proprietà del materiale (inclusa qualsiasi proprietà ereditata da [page:Material]) può essere passata qui.

## Proprietà

Vedi la classe base [page:Material] per le proprietà comuni.

### [property:Boolean clipping]

Definisce se questo materiale supporta il clipping; true per consetire al renderer di passare l'uniforme di clippingPlanes. L'impostazione predefinita è `false`.

### [property:Object defaultAttributeValues]

Quando la geometria renderizzata non include questi attributi ma il materiale sì, questi valori predefiniti verranno passati agli shader. Ciò evita errori quando mancano i dati del buffer. `this.defaultAttributeValues = { 'color': [ 1, 1, 1 ], 'uv': [ 0, 0 ], 'uv1': [ 0, 0 ] };`

### [property:Object defines]

Definisce le costanti personalizzate utilizzando le direttive `#define` nel codice GLSL sia per il vertex shader che il fragment shader; ogni coppia chiave/valore produce un'altra direttiva: `defines: { FOO: 15, BAR: true }` restituisce le linee `#define FOO 15 #define BAR true` nel codice GLSL.

### [property:Object extensions]

Un oggetto con le seguenti proprietà: `this.extensions = { clipCullDistance: false, // set to use vertex shader clipping multiDraw: false // set to use vertex shader multi_draw / enable gl_DrawID };`

### [property:Boolean fog]

Definisce se il colore del materiale è influenzato dalle impostazioni globali della nebbia. true per passare le uniformi allo shader. Il valore predefinito è `false`.

### [property:String fragmentShader]

Codice GLSL del fragment shader. Questo è il codice effettivo per lo shader. Nell'esempio sopra, il codice `vertexShader` e `fragmentShader` viene estratto dal DOM; potrebbe essere passato come stringa direttamente o caricato tramite AJAX.

### [property:String glslVersion]

Definisce la versione GLSL del codice dello shader personalizzato. I valori validi sono `THREE.GLSL1` o `THREE.GLSL3`. Il valore predefinito è `null`.

### [property:String index0AttributeName]

Se impostato, questo chiama [link:https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bindAttribLocation gl.bindAttribLocation] per associare un indice di vertice generico a una variabile di attributo. Il valore predefinito è `undefined`.

### [property:Boolean isShaderMaterial]

Flag di sola lettura per verificare se l'oggetto passato è di tipo [name].

### [property:Boolean lights]

Definisce se questo materiale utilizza l'illuminazione; true per trasmettere dati uniformi relativi all'illuminazione a questo shader. L'impostazione predefinita è `false`.

### [property:Float linewidth]

Controlla lo spessore del wireframe. Il valore predefinito è `1`.
A causa delle limitazioni del [link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf profilo OpenGL Core] con il renderer [page:WebGLRenderer WebGL] sulla maggior parte delle piattaforme, la larghezza di riga sarà sempre 1 indipendentemente dal valore impostato.

### [property:Boolean flatShading]

Definisce se il materiale viene renderizzato con un'ombreggiatura piatta. Il valore predefinito è `false`.

### [property:Object uniforms]

Un oggetto della forma: `{ "uniform1": { value: 1.0 }, "uniform2": { value: 2 } }` specificando le uniformi da passare al codice dello shader; la chiave è il nome della uniform, il valore è la definizione del modulo `{ value: 1.0 }` dove `value` è il valore della uniforme. I nomi devono corrispondere al nome della uniforme, come definito nel codice GLSL. Si noti che le uniformi vengono aggiornate su ogni frame, quindi l'aggiornamento del valore della uniforme aggiornerà immediatamente il valore disponinbile per il codice GLSL.

### [property:Boolean uniformsNeedUpdate]

Può essere utilizzata per forzare un aggiornamento della uniform durante la modifica delle uniformi in [page:Object3D.onBeforeRender](). Il valore predefinito è `false`.

### [property:Boolean vertexColors]

Definisce se viene utilizzata la colorazione dei vertici. Il valore predefinito è `false`.

### [property:String vertexShader]

Il codice GLSL del vertex shader. Questo è il codice effettivo per lo shader. Nell'esempio sopra, il codice `vertexShader` e `fragmentShader` viene estratto dal DOM; potrebbe essere passato come stringa direttamente o caricato tramite AJAX.

### [property:Boolean wireframe]

Rendering della geometria come wireframe (utilizzando GL_LINES instead of GL_TRIANGLES). Il valore predefinito è `false` (cioè renderizzazione come poligoni piatti).

### [property:Float wireframeLinewidth]

Controlla lo spessore del wireframe. Il valore predefinito è `1`.
A causa delle limitazioni del [link:https://www.khronos.org/registry/OpenGL/specs/gl/glspec46.core.pdf profilo OpenGL Core] con il renderer [page:WebGLRenderer WebGL] sulla maggior parte delle piattaforme, la larghezza di riga sarà sempre 1 indipendentemente dal valore impostato.

## Metodi

Vedi la classe base [page:Material] per i metodi comuni.

### [method:ShaderMaterial clone]()

Genera una copia superficiale di questo materiale. Si noti che il vertexShader e il fragmentShader sono copiati `per riferimento`, così come le definizioni degli `attributi`; questo significa che i cloni del materiale condivideranno lo stesso [page:WebGLProgram] compilato. Tuttavia, le uniform vengono copiate in base al `valore`, il che consente di avere diversi set di uniformi per diverse copie del materiale.

## Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]