Paquete | flash.display |
Clase | public final dynamic class ShaderParameter |
Herencia | ShaderParameter Object |
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
value
.
Una instancia de ShaderParameter que representa un parámetro para una instancia de Shader. Se accede como una propiedad de la propiedad data
de la instancia de Shader. La propiedad de ShaderParameter tiene el mismo nombre que el parámetro en el código de sombreado. Por ejemplo, si un sombreado define un parámetro llamado radius
, la instancia de ShaderParameter que representa el parámetro radius
está disponible como la propiedad radius
, como puede verse a continuación:
var radiusParam:ShaderParameter = myShader.data.radius;
Además de las propiedades definidas de la clase ShaderParameter, cada instancia de ShaderParameter tiene propiedades adicionales que corresponden a los metadatos definidos por el parámetro. Estas propiedades se añaden al objeto ShaderParameter en el momento de su creación. Los nombres de las propiedades coinciden con los nombres de metadatos especificados en el código fuente del sombreado. El tipo de datos de cada propiedad varía según el tipo de datos de los metadatos correspondientes. Un valor de metadatos de texto, como "description", es una instancia de String. Una propiedad de metadatos con un valor que no sea una cadena (como minValue
o defaultValue
) se representa como una instancia de Array. El número de elementos y los tipos de datos de elementos dependen de los valores de los metadatos.
Por ejemplo, consideremos un sombreado que incluye las dos siguientes declaraciones de parámetros:
parameter float2 size < description: "The size of the image to which the kernel is applied"; minValue: float2(0.0, 0.0); maxValue: float2(100.0, 100.0); defaultValue: float2(50.0, 50.0); >; parameter float radius < description: "The radius of the effect"; minValue: 0.0; maxValue: 50.0; defaultValue: 25.0; >;
La instancia de ShaderParameter correspondiente al parámetro size
tiene las siguientes propiedades de metadatos además de sus propiedades incorporadas:
Nombre de la propiedad | Tipo de datos | Valor |
---|---|---|
name
| String |
"size"
|
description
| String |
"El tamaño de la imagen a la que se aplica el núcleo"
|
minValue
| Array |
[0, 0]
|
maxValue
| Array |
[100, 100]
|
defaultValue
| Array |
[50, 50]
|
El objeto ShaderParameter correspondiente al parámetro radius
tiene las siguientes propiedades adicionales:
Nombre de la propiedad | Tipo de datos | Valor |
---|---|---|
name
| String |
"radius"
|
description
| String |
"El radio del efecto"
|
minValue
| Array |
[0]
|
maxValue
| Array |
[50]
|
defaultValue
| Array |
[25]
|
Generalmente, el código del desarrollador no crea ninguna instancia de ShaderParameter directamente. Las instancias de ShaderParameter se crean para cada uno de los parámetros del sombreado cuando se crea la instancia de Shader.
Elementos de API relacionados
Propiedad | Definido por | ||
---|---|---|---|
constructor : Object
Una referencia a la clase de objeto o función constructora para una instancia de objeto determinada. | Object | ||
index : int [solo lectura]
Índice basado en cero del parámetro. | ShaderParameter | ||
type : String [solo lectura]
El tipo de datos del parámetro tal como se define en el sombreado. | ShaderParameter | ||
value : Array
El valor o los valores que se transfieren como el valor del parámetro al sombreado. | ShaderParameter |
Método | Definido por | ||
---|---|---|---|
Crea una instancia de ShaderParameter. | ShaderParameter | ||
Indica si un objeto tiene definida una propiedad especificada. | Object | ||
Indica si hay una instancia de la clase Object en la cadena de prototipo del objeto especificado como parámetro. | Object | ||
Indica si existe la propiedad especificada y si es enumerable. | Object | ||
Establece la disponibilidad de una propiedad dinámica para operaciones de bucle. | Object | ||
Devuelve la representación de cadena de este objeto, con formato según las convenciones específicas de configuración regional. | Object | ||
Devuelve la representación de cadena del objeto especificado. | Object | ||
Devuelve el valor simple del objeto especificado. | Object |
index | propiedad |
type | propiedad |
type:String
[solo lectura] Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El tipo de datos del parámetro tal como se define en el sombreado. El conjunto de valores posibles de la propiedad type
se define con las constantes de la clase ShaderParameterType.
Implementación
public function get type():String
Elementos de API relacionados
value | propiedad |
value:Array
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
El valor o los valores que se transfieren como el valor del parámetro al sombreado. La propiedad value
es un conjunto Array indexado. El número y el tipo de elementos del conjunto corresponde al tipo de datos del parámetro; se pueden determinar mediante la propiedad type
.
En la siguiente tabla se indica el tipo de parámetro y el número y tipo de datos correspondiente de los elementos del conjunto value
:
Tipo de parámetro | Número de elementos | Tipo de datos de elementos |
---|---|---|
float (ShaderParameterType.FLOAT ) | 1 | Number |
float2 (ShaderParameterType.FLOAT2 ) | 2 | Number |
float3 (ShaderParameterType.FLOAT3 ) | 3 | Number |
float4 (ShaderParameterType.FLOAT4 ) | 4 | Number |
int (ShaderParameterType.INT ) | 1 | int o uint |
int2 (ShaderParameterType.INT2 ) | 2 | int o uint |
int3 (ShaderParameterType.INT3 ) | 3 | int o uint |
int4 (ShaderParameterType.INT4 ) | 4 | int o uint |
bool (ShaderParameterType.BOOL ) | 1 | Boolean |
bool2 (ShaderParameterType.BOOL2 ) | 2 | Boolean |
bool3 (ShaderParameterType.BOOL3 ) | 3 | Boolean |
bool4 (ShaderParameterType.BOOL4 ) | 4 | Boolean |
float2x2 (ShaderParameterType.MATRIX2X2 ) | 4 | Number |
float3x3 (ShaderParameterType.MATRIX3X3 ) | 9 | Number |
float4x4 (ShaderParameterType.MATRIX4X4 ) | 16 | Number |
En los tipos de parámetros del conjunto, los elementos del conjunto llenan primero las filas y después las columnas. Por ejemplo, supongamos que se utiliza la siguiente línea de ActionScript para llenar un parámetro float2x2
llamado myMatrix
:
myShader.data.myMatrix.value = [.1, .2, .3, .4];
En el sombreado, los elementos de la matriz tienen los valores siguientes:
myMatrix[0][0]
: .1myMatrix[0][1]
: .2myMatrix[1][0]
: .3myMatrix[1][1]
: .4
Implementación
public function get value():Array
public function set value(value:Array):void
ShaderParameter | () | Información sobre |
public function ShaderParameter()
Versión del lenguaje: | ActionScript 3.0 |
Versiones de motor de ejecución: | Flash Player 10, AIR 1.5 |
Crea una instancia de ShaderParameter. El código del desarrollador no llama al constructor ShaderParameter directamente. Las instancias de ShaderParameter se crean para cada uno de los parámetros del sombreado cuando se crea la instancia de Shader.
Tue Jun 12 2018, 02:12 PM Z