Sprache

RuntimeShader Klasse

Definition

A RuntimeShader berechnet eine Pro-Pixel-Farbe basierend auf der Ausgabe einer benutzerdefinierten Android Graphics Shading Language (AGSL)-Funktion.

[Android.Runtime.Register("android/graphics/RuntimeShader", ApiSince=33, DoNotGenerateAcw=true)]
public class RuntimeShader : Android.Graphics.Shader
[<Android.Runtime.Register("android/graphics/RuntimeShader", ApiSince=33, DoNotGenerateAcw=true)>]
type RuntimeShader = class
    inherit Shader
Vererbung
RuntimeShader
Attribute

Hinweise

A RuntimeShader berechnet eine Pro-Pixel-Farbe basierend auf der Ausgabe einer benutzerdefinierten Android Graphics Shading Language (AGSL)-Funktion.

<h3>Android Graphics Shading Language</h3>

Die AGSL-Syntax ähnelt der OpenGL ES Shading Language, aber es gibt einige wichtige Unterschiede, die hier hervorgehoben sind. Die meisten dieser Unterschiede werden in einer grundlegenden Tatsache zusammengefasst: <b>Mit GPU-Schattierungssprachen programmieren Sie eine Phase der GPU-Pipeline. Mit AGSL programmieren Sie eine Phase der Canvas Pipeline oder RenderNode Zeichnungspipeline.</b>

Insbesondere steuert ein GLSL-Fragment-Shader das gesamte Verhalten der GPU zwischen dem Rasterizer und der Mischhardware. Dieser Shader erledigt alle Aufgaben, um eine Farbe zu berechnen, und die farbe, die generiert wird, ist genau das, was der Mischphase der Pipeline zugeführt wird.

Im Gegensatz dazu existieren AGSL-Funktionen als Teil einer größeren Pipeline. Wenn Sie einen Zeichnungsvorgang Canvas ausstellen, fasst Android (im Allgemeinen) einen einzelnen GPU-Fragment-Shader zusammen, um alle erforderlichen Aufgaben auszuführen. Dieser Shader enthält in der Regel mehrere Teile. Sie kann beispielsweise Folgendes umfassen:

<ul><li>Auswerten, ob ein Pixel innerhalb oder außerhalb der gezeichneten Form liegt (oder auf dem Rahmen, wo es Antialiasing anwenden kann).</li li><>Auswerten, ob ein Pixel innerhalb oder außerhalb des Clippingbereichs liegt (wieder mit möglicher Antialiasinglogik für Rahmenpixel).</li><>li Logic für das Shader, ColorFilterund BlendMode auf der Paint.</li li><>Farbraumkonvertierungscode im Rahmen der Farbverwaltung von Android.</li></ul>

Ein RuntimeShader, wie andere Shader Typen, trägt effektiv eine Funktion zum Fragmentshader der GPU bei.

<h3>AGSL-Shaderausführung</h3>

Genau wie ein GLSL-Shader beginnt ein AGSL-Shader die Ausführung in einer Hauptfunktion. Im Gegensatz zu GLSL empfängt die Funktion als Eingabeparameter die Position des Pixels im Canvas oder RenderNode Koordinatenbereich (ähnlich wie gl_fragCoord) und gibt die Farbe zurück, die als vec4 schattiert werden soll (ähnlich wie bei vec4-Farbe oder gl_FragColor in GLSL).

vec4 main(vec2 canvas_coordinates);

AGSL und GLSL verwenden standardmäßig unterschiedliche Koordinatenräume. In GLSL ist die Fragmentkoordinate (fragCoord) relativ zur unteren linken Seite. AGSL entspricht dem Bildschirmkoordinatensystem von Android Canvas , das seinen Ursprung als obere linke Ecke hat. Dies bedeutet, dass die Koordinaten, die als Parameter in der Hauptfunktion bereitgestellt werden, lokal auf der Canvas sind, mit Ausnahme von Shader#getLocalMatrix(Matrix) Transformationen, die auf diesen Shader angewendet werden. Wenn der Shader durch eine andere Verwendung #setInputShader(String, Shader)aufgerufen wird, kann dieser übergeordnete Shader die Eingabekoordinaten beliebig ändern.

"agsl-and-color-spaces"/><h3>AGSL und Color Spaces</h3>

Android-Grafiken und durch Erweiterung RuntimeShader werden farbverwaltet. Die Arbeit ColorSpace für einen AGSL-Shader ist so definiert, dass es sich um den Farbraum des Ziels handelt, der in den meisten Fällen durch Window#setColorMode(int)bestimmt wird.

Beim Erstellen eines AGSL-Shaders wissen Sie nicht, was der Arbeitsfarbraum ist. Bei vielen Effekten ist dies in Ordnung, da standardmäßig Farbeingaben automatisch in den Arbeitsfarbraum konvertiert werden. Bei bestimmten Effekten kann es wichtig sein, einige Mathematik in einem festen, bekannten Farbraum zu erledigen. Ein gängiges Beispiel ist Beleuchtung – um eine physisch genaue Beleuchtung zu erhalten, sollte Mathematik in einem linearen Farbraum erfolgen. Um dies zu unterstützen, bietet AGSL zwei systeminterne Funktionen, mit denen Farben zwischen dem Arbeitsfarbraum und dem ColorSpace.Named#LINEAR_EXTENDED_SRGB Farbraum konvertiert werden:

vec3 toLinearSrgb(vec3 color);
            vec3 fromLinearSrgb(vec3 color);

<h3>AGSL und Prämultipliziertes Alpha</h3>

Beim Umgang mit transparenten Farben gibt es zwei (häufige) mögliche Darstellungen: gerade (nicht zugeordnete) Alpha und prämultipliziertes (zugeordnetes) Alpha. In ASGL wird davon ausgegangen, dass die von der Hauptfunktion zurückgegebene Farbe prämultipliziert wird. AGSL-Verwendung von prämultiplizierten Alpha impliziert:

<ul><li>Wenn Ihr AGSL-Shader transparente Farben zurückgibt, müssen Sie die RGB mit A multiplizieren. Die resultierende Farbe sollte [R*A, G*A, B*A, A], nicht [R, G, B, A] sein.</li li><>Für komplexere Shader müssen Sie verstehen, welche Farben prämultipliziert sind und wie gerade. Viele Vorgänge sind nicht sinnvoll, wenn Sie beide Arten von Farben zusammen mischen.</li></ul>

<h3>Uniforms</h3>

AGSL, wie GLSL, macht das Konzept von Uniformen verfügbar. Eine AGSL-Uniform wird als schreibgeschützte, globale Variable definiert, auf die der AGSL-Code zugreifen kann und von einer Reihe von Settermethoden RuntimeShaderinitialisiert wird. AGSL macht zwei primitive uniform-Datentypen (float, int) und zwei spezialisierte Typen (Farben, Shader) verfügbar, die unten beschrieben sind.

<h4>Primitive Uniforms</h4>

Es gibt zwei primitive einheitliche Typen, die von AGSL, float und int unterstützt werden. Für diese Typen und Uniforms, die eine Gruppierung dieser Typen darstellen, z. B. Arrays und Matrizen, gibt es entsprechende RuntimeShader Methoden, um sie zu initialisieren. <table border="2" width="85%" align="center" cellpadding="5">thead<>tr><th> Java Type/th>><AGSL Type<</th<>Method/th Method</th/th>></tr<>/thead<>

<tbody><tr><td rowspan="4">Floats</td<>td>float</td td<>/tdRuntimeShader#setFloatUniform(String, float)<><>/tr><<>td>vec2</td td<RuntimeShader#setFloatUniform(String, float, float)<>>/td></tr><<>td>vec3</td><td tdRuntimeShader#setFloatUniform(String, float, float, float)<>/td<><<>>> vec4</td td td></td><RuntimeShader#setFloatUniform(String, float, float, float, float)/td<>/tr tr><><td rowspan="4">Integers</td td<>>int</td td<RuntimeShader#setIntUniform(String, int)<>>/td></tr>><<td>ivec2</td td><td>RuntimeShader#setIntUniform(String, int, int)</td></tr><><td>ivec3</td><tdRuntimeShader#setIntUniform(String, int, int, int)<>/td<>/tr>><<td>ivec4</td td/td/tdRuntimeShader#setIntUniform(String, int, int, int, int)<<>>/tr><><tr><td rowspan="2">Matrices and Arrays</td td><td>mat2, mat3, and mat4, and float[]</td<>td/tdRuntimeShader#setFloatUniform(String, float[])<><<>>><> int[]</td><tdRuntimeShader#setIntUniform(String, int[])<>/td<>/tr/tr<>/tbody></table>

Beispielsweise würde ein einfacher AGSL-Shader, der eine Float-Uniform verwendet, um die Transparenz der Ausgabefarbe zu modulieren, wie folgt aussehen würde:

uniform float alpha;
            vec4 main(vec2 canvas_coordinates) {
                vec3 red = vec3(1.0, 0.0, 0.0);
                return vec4(red * alpha, alpha);
            }

Nach dem Erstellen eines RuntimeShader Mit diesem Programm kann die Uniform dann initialisiert und pro Frame aktualisiert werden, indem sie mit dem Wert alphan.RuntimeShader#setFloatUniform(String, float) Der Wert einer primitiven uniform-Standardeinstellung ist 0, wenn sie im AGSL-Shader deklariert, aber nicht initialisiert wird.

<h4>Color Uniforms</h4>

AGSL weiß nicht, ob einheitliche Variablen Farben enthalten, sie werden nicht automatisch in den Arbeitsfarbraum des Shaders zur Laufzeit konvertiert. Sie können Ihre vec4-Uniform jedoch mit dem Qualifizierer "layout(color)" bezeichnen, der Android informiert, dass die Uniform als Farbe verwendet wird. Dadurch kann AGSL den einheitlichen Wert in den Arbeitsfarbraum transformieren. Deklarieren Sie in AGSL die uniform wie folgt:

layout(color) uniform vec4 inputColorA;
            layout(color) uniform vec4 inputColorB;
            vec4 main(vec2 canvas_coordinates) {
                // blend the two colors together and return the resulting color
                return mix(inputColorA, inputColorB, 0.5);
            }

Nach dem Erstellen eines RuntimeShader Mit diesem Programm können die Uniforms dann per Aufruf RuntimeShader#setColorUniform(String, int), oder RuntimeShader#setColorUniform(String, long)RuntimeShader#setColorUniform(String, Color) mit den gewünschten Farben pro Frame initialisiert und aktualisiert werden. Der Wert einer Farbeinheit ist nicht definiert, wenn sie im AGSL-Shader deklariert, aber nicht initialisiert wird.

<h4>Shader Uniforms</h4> In GLSL kann ein Fragment-Shader eine Textur beispielen. Für AGSL anstelle von Sampling-Texturen können Sie eine Stichprobe aus jedem Shaderbeispielen , einschließlich, aber nicht beschränkt auf BitmapShader. Um deutlich zu machen, dass Sie auf einem Shader Objekt arbeiten, gibt es keine "Sample"-Methode. Stattdessen verfügt die Shader-Uniform über eine "eval()"-Methode. Diese Unterscheidung ermöglicht AGSL-Shadern das Beispiel von vorhandenen Bitmap- und Farbverlaufsshadern sowie anderen RuntimeShader Objekten. Deklarieren Sie in AGSL die uniform wie folgt:

uniform shader myShader;
            vec4 main(vec2 canvas_coordinates) {
                // swap the red and blue color channels when sampling from myShader
                return myShader.eval(canvas_coordinates).bgra;
            }

Nach dem Erstellen eines RuntimeShader Mit diesem Programm kann die Shader-Uniform dann per Frame initialisiert und aktualisiert werden, indem sie mit dem gewünschten Shader aufgerufen RuntimeShader#setInputShader(String, Shader) wird. Der Wert einer Shader-Uniform ist nicht definiert, wenn sie im AGSL-Shader deklariert, aber nicht initialisiert wird.

Obwohl die meisten BitmapShaderFarben enthalten, die farbverwaltet werden sollen, enthalten einige Daten, die eigentlich keine Farben sind. Dazu gehören Bitmaps, die Normale, Materialeigenschaften (z. B. Rauheit), Heightmaps oder andere rein mathematische Daten speichern, die in einer Bitmap gespeichert werden. Wenn Sie diese Arten von Shadern in AGSL verwenden, möchten Sie sie wahrscheinlich mit #setInputBuffer(String, BitmapShader)initialisieren. Shader, die auf diese Weise initialisiert wurden, funktionieren ähnlich wie eine normale BitmapShader (einschließlich Filterung und Tilung), mit einigen wichtigen Unterschieden: <ul><li>Keine Farbraumtransformation wird angewendet (der Farbraum der Bitmap wird ignoriert).</li li><>Bitmaps, die "false" Bitmap#isPremultiplied() zurückgeben, werden nicht automatisch vormultipliziert.</li></ul>

Beachten Sie außerdem, dass beim Sampling aus einem BitmapShader Shader keine normalisierten Koordinaten (z. B. eine Textur in GLSL) verwendet werden. Sie verwendet (0, 0) in der oberen linken Ecke und (Breite, Höhe) in der unteren rechten Ecke. Normalerweise ist dies genau das, was Sie wollen. Wenn Sie den Shader anhand der Koordinaten auswerten, die an Ihr AGSL-Programm übergeben wurden, ist die Skalierung richtig. Wenn Sie diese Koordinaten jedoch anpassen möchten (um eine art neu zuzuordnende Bitmap durchzuführen), denken Sie daran, dass die Koordinaten lokal auf dem Zeichenbereich sind.

Java Dokumentation für android.graphics.RuntimeShader.

Teile dieser Seite sind Änderungen auf der Grundlage von Arbeiten, die von der Android Open Source Project erstellt und gemeinsam verwendet und gemäß den in der 2.5 Attribution License beschriebenen Begriffen verwendet werden.

Konstruktoren

Name Beschreibung
RuntimeShader(IntPtr, JniHandleOwnership)

Erstellt eine verwaltete Instanz, die ein vorhandenes Java -Objekt darstellt.

RuntimeShader(String)

Erstellt einen neuen RuntimeShader.

Eigenschaften

Name Beschreibung
Class

Gibt die Laufzeitklasse dieses Werts Objectzurück.

(Geerbt von Object)
Handle

Das Handle für die zugrunde liegende Android-Instanz.

(Geerbt von Object)
JniIdentityHashCode

Ruft den Identitätshashcode ab, der diesem Java Peer von der Interop-Laufzeit zugewiesen ist.

(Geerbt von Object)
JniManagedPeerState

Ruft die Statuskennzeichnungen ab, die zuletzt von der Laufzeit zugewiesen wurden.

(Geerbt von JavaObject)
JniPeerMembers

Ruft die JNI-Metadaten ab, die für den Zugriff auf Member dieser Java Bindung verwendet werden.

PeerReference

Ruft den JNI-Objektverweis für diesen Java Peer ab.

(Geerbt von Object)
ThresholdClass

Ruft die Java Klasse ab, die für die verteilte virtuelle Methode verwendet wird.

ThresholdType

Ruft den verwalteten Typ ab, der diese Java Bindung deklariert.

Methoden

Name Beschreibung
Clone()

Erstellt und gibt eine Kopie dieses Objekts zurück.

(Geerbt von Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

Delegiert die Konstruktion dieses Peers an den Wertmanager der Laufzeit.

(Geerbt von JavaObject)
Dispose()

Veröffentlicht die Ressourcen, die von diesem Java Peer gehalten werden.

(Geerbt von Object)
Dispose(Boolean)

Veröffentlicht die Ressourcen, die von diesem Java Peer gehalten werden.

(Geerbt von Object)
DisposeUnlessReferenced()

Fordert den Wert-Manager auf, diesen Peer zu verwerfen, es sei denn, seine Zuordnung behält dieselbe verwaltete Instanz bei.

(Geerbt von JavaObject)
Equals(Object)

Überprüft, ob ein anderer verwalteter Peer auf dasselbe Java-Objekt verweist.

(Geerbt von JavaObject)
Equals(Object)

Gibt an, ob ein anderes Objekt "gleich" diesem Objekt ist.

(Geerbt von Object)
GetHashCode()

Gibt einen Hashcodewert für das Objekt zurück.

(Geerbt von Object)
GetLocalMatrix(Matrix)

Gibt "true" zurück, wenn der Shader über eine lokale Matrix ohne Identität verfügt.

(Geerbt von Shader)
JavaFinalize()
Veraltet.

Wird vom Garbage Collector für ein Objekt aufgerufen, wenn die Garbage Collection bestimmt, dass keine weiteren Verweise auf das Objekt vorhanden sind.

(Geerbt von Object)
Notify()

Aktiviert einen einzelnen Thread, der auf dem Monitor dieses Objekts wartet.

(Geerbt von Object)
NotifyAll()

Aktiviert alle Threads, die auf dem Monitor dieses Objekts warten.

(Geerbt von Object)
SetColorUniform(String, Color)

Legt den einheitlichen Farbwert fest, der diesem Shader entspricht.

SetColorUniform(String, ColorObject)

Legt den einheitlichen Farbwert fest, der diesem Shader entspricht.

SetColorUniform(String, Int64)

Legt den einheitlichen Farbwert fest, der diesem Shader entspricht.

SetFloatUniform(String, Single, Single, Single, Single)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetFloatUniform(String, Single, Single, Single)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetFloatUniform(String, Single, Single)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetFloatUniform(String, Single)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetFloatUniform(String, Single[])

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetHandle(IntPtr, JniHandleOwnership)

Legt die Handle-Eigenschaft fest.

(Geerbt von Object)
SetInputBuffer(String, BitmapShader)

Weist den einheitlichen Shader dem bereitgestellten Shaderparameter zu.

SetInputColorFilter(String, ColorFilter)

Weist den einheitlichen Farbfilter dem bereitgestellten Farbfilterparameter zu.

SetInputShader(String, Shader)

Weist den einheitlichen Shader dem bereitgestellten Shaderparameter zu.

SetInputXfermode(String, RuntimeXfermode)

Weist dem bereitgestellten xfermode-Parameter den uniform xfermode zu.

SetIntUniform(String, Int32, Int32, Int32, Int32)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetIntUniform(String, Int32, Int32, Int32)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetIntUniform(String, Int32, Int32)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetIntUniform(String, Int32)

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetIntUniform(String, Int32[])

Legt den uniform-Wert fest, der diesem Shader entspricht.

SetLocalMatrix(Matrix)

Legen Sie die lokale Matrix des Shaders fest.

(Geerbt von Shader)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Speichert einen Verweiswert im Steuerelementblock, ohne eine JNI-Referenzkopie zu erstellen.

(Geerbt von JavaObject)
SetWorkingColorSpace(ColorSpace)

Legt den Arbeitsfarbraum für diesen Shader fest.

ToArray<T>()

Erstellt ein verwaltetes Array aus diesem Java Arraywrapper.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolgendarstellung des Objekts zurück.

(Geerbt von Object)
UnregisterFromRuntime()

Hebt die Registrierung dieses Java Peers aus der Interop-Laufzeit auf.

(Geerbt von Object)
Wait()

Bewirkt, dass der aktuelle Thread wartet, bis er wach ist, in der Regel durch em benachrichtigt/em< oder >em<unterbrochen>/em<.><>

(Geerbt von Object)
Wait(Int64, Int32)

Bewirkt, dass der aktuelle Thread wartet, bis er wach ist, in der Regel durch <em>benachrichtigt</em> oder <em>unterbrochen</em> oder bis eine bestimmte Menge an Echtzeit verstrichen ist.

(Geerbt von Object)
Wait(Int64)

Bewirkt, dass der aktuelle Thread wartet, bis er wach ist, in der Regel durch <em>benachrichtigt</em> oder <em>unterbrochen</em> oder bis eine bestimmte Menge an Echtzeit verstrichen ist.

(Geerbt von Object)

Explizite Schnittstellenimplementierungen

Name Beschreibung
IJavaPeerable.Disposed()

Kennzeichnet diesen Peer als verworfen und Anrufe Dispose mit disposing Festgelegt auf true.

(Geerbt von JavaObject)
IJavaPeerable.Finalized()

Kennzeichnet diesen Peer als verworfen und Anrufe Dispose mit disposing Festgelegt auf false.

(Geerbt von JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Ruft den systemeigenen Steuerelementblockzeiger ab, der von diesem Peer verwendet wird.

(Geerbt von JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Speichert den von der Laufzeit bereitgestellten Identitätshashcode.

(Geerbt von JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Ersetzt die gespeicherten verwalteten Peerstatuskennzeichnungen.

(Geerbt von JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Aktualisiert den Peerverweis und gibt den Steuerelementblock eines verworfenen Peers frei, wenn der Verweis ungültig ist.

(Geerbt von JavaObject)

Erweiterungsmethoden

Name Beschreibung
GetJniTypeName(IJavaPeerable)

Ruft den JNI-Namen des Typs der Instanz selfab.

JavaAs<TResult>(IJavaPeerable)

Versuchen Sie, die Eingabe selfzu TResult erzwingen, und überprüfen Sie, ob die Koersion auf der Java Seite gültig ist.

JavaCast<TResult>(IJavaObject)

Führt eine android-laufzeitgecheckte Typkonvertierung aus.

JavaCast<TResult>(IJavaObject)

Verwendet einen kompatiblen verwalteten Peer wieder oder ruft einen Wrapper des angeforderten Typs ab.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Versuchen Sie, die Eingabe selfzu TResult erzwingen, und überprüfen Sie, ob die Koersion auf der Java Seite gültig ist.

Gilt für: