Skip to content
/ VB_ChromaGameLoopSample Public

VB Chroma sample that dynamically sets colors in a game loop

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

razerofficial/VB_ChromaGameLoopSample

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
Animations
Animations
 
 
My Project
My Project
 
 
images
images
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
App.config
App.config
 
 
CChromaEditorLibrary.dll
CChromaEditorLibrary.dll
 
 
CChromaEditorLibrary.pdb
CChromaEditorLibrary.pdb
 
 
CChromaEditorLibrary64.dll
CChromaEditorLibrary64.dll
 
 
CChromaEditorLibrary64.pdb
CChromaEditorLibrary64.pdb
 
 
ChromaAnimationAPI.vb
ChromaAnimationAPI.vb
 
 
Program.vb
Program.vb
 
 
README.md
README.md
 
 
RazerErrors.vb
RazerErrors.vb
 
 
SampleApp.vb
SampleApp.vb
 
 
VB_ChromaGameLoopSample.sln
VB_ChromaGameLoopSample.sln
 
 
VB_ChromaGameLoopSample.vbproj
VB_ChromaGameLoopSample.vbproj
 
 
VB_ChromaGameLoopSample.vbproj.user
VB_ChromaGameLoopSample.vbproj.user
 
 
open_vs_code.cmd
open_vs_code.cmd
 
 

Repository files navigation

Latest

Visual Basic - Chroma Game Loop Sample App

Table of Contents

See Also

Docs:

Plugins:

  • CChromaEditor - C++ native MFC library for playing and editing Chroma animations

Quick Start

  • Install Synapse

  • Make sure the Chroma Connect module is installed.

image_2

  • If you don't have Chroma hardware, you can see Chroma effects with the Chroma Emulator

About

The VB Chroma Game Loop Sample App is a sample project that dynamically sets colors in a game loop.

Screenshot:

image_1

Chroma Editor Library

The Chroma Editor Library is a helper library for Chroma animation playback and realtime manipulation of Chroma animations.

The latest versions of the Chroma Editor Library can be found in Releases for Windows-PC and Windows-Cloud.

Windows PC

For Windows PC builds the RzChromaSDK.dll and RzChromaStreamPlugin.dll are not packaged with the build. These libraries are automatically updated and managed by Synapse and the Chroma Connect module. Avoid including these files in your build folder for Windows PC builds.

32-bit libraries

Win32BuildFolder\CChromaEditorLibrary.dll

64-bit libraries

Win64BuildFolder\CChromaEditorLibrary64.dll

Windows Cloud

Windows Cloud builds run on cloud platforms using Windows such as Amazon Luna, Microsoft Game Pass, and NVidia GeForce Now. Game instances run in the cloud without direct access to Chroma hardware. By running the Windows Cloud version of the library Chroma effects can reach your local machine and connected hardware. Cloud instances won't have Synapse installed which requires special cloud versions of the libraries. The Chroma Editor Library uses the core RzChromaSDK low-level library to send Chroma effects to the cloud with the RzChromaStreamPlugin streaming library. Viewers can watch the cloud stream via the Razer Stream Portal.

32-bit libraries

Win32BuildFolder\CChromaEditorLibrary.dll
Win32BuildFolder\RzChromaSDK.dll
Win32BuildFolder\RzChromaStreamPlugin.dll

64-bit libraries

Win64BuildFolder\CChromaEditorLibrary64.dll
Win64BuildFolder\RzChromaSDK64.dll
Win64BuildFolder\RzChromaStreamPlugin64.dll

API Class

The ChromaAnimationAPI module provides a wrapper for the Chroma Editor Library. The wrapper for the API can be found at ChromaAnimationAPI.vb.

Initialization

The ChromaAnimationAPI.InitSDK(appInfo) method returns RazerErrors.RZRESULT_SUCCESS when initialization has succeeded. Avoid making calls to the Chroma API when anything other than success is returned. A unsuccessful result indicates Chroma is not present on the machine.

  Dim appInfo As ChromaSDK.APPINFOTYPE = New APPINFOTYPE()

  appInfo.Title = "Sample Game Title";
  appInfo.Description = "Sample Game Description";
  appInfo.Author_Name = "Company Name";
  appInfo.Author_Contact = "Company Website or Email";

  //    &H1 |  // Keyboards
  //    &H2 |  // Mice
  //    &H4 |  // Headset
  //    &H8 |  // Mousepads
  //    &H10 | // Keypads
  //    &H20   // ChromaLink devices
  appInfo.SupportedDevice = (&H1 Xor &H2 Xor &H4 Xor &H8 Xor &H10 Xor &H20)
  //    &H1 | // Utility. (To specifiy this is an utility application)
  //    &H2   // Game. (To specifiy this is a game);
  appInfo.Category = &H2;
  
  Dim result As Integer = ChromaAnimationAPI.InitSDK(appInfo);
  if (result <> RazerErrors.RZRESULT_SUCCESS)
  {
    Console.Error.WriteLine("Failed to initialize Chroma SDK with error={0}\r\n", result);

    // avoid making Chroma API calls after a non-zero init result
    return;
  }

API

AddColor

Return the sum of colors

Dim result As Integer = ChromaAnimationAPI.AddColor(color1 As Integer, color2 As Integer)

AddFrame

Adds a frame to the Chroma animation and sets the duration (in seconds). The color is expected to be an array of the dimensions for the deviceType/device. The length parameter is the size of the color array. For EChromaSDKDevice1DEnum the array size should be MAX LEDS. For EChromaSDKDevice2DEnum the array size should be MAX ROW * MAX COLUMN. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.AddFrame(animationId As Integer, duration As Single, colors As Integer(), length As Integer)

AddNonZeroAllKeysAllFrames

Add source color to target where color is not black for all frames, reference source and target by id.

ChromaAnimationAPI.AddNonZeroAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

AddNonZeroAllKeysAllFramesName

Add source color to target where color is not black for all frames, reference source and target by name.

ChromaAnimationAPI.AddNonZeroAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

AddNonZeroAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AddNonZeroAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

AddNonZeroAllKeysAllFramesOffset

Add source color to target where color is not black for all frames starting at offset for the length of the source, reference source and target by id.

ChromaAnimationAPI.AddNonZeroAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

AddNonZeroAllKeysAllFramesOffsetName

Add source color to target where color is not black for all frames starting at offset for the length of the source, reference source and target by name.

ChromaAnimationAPI.AddNonZeroAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

AddNonZeroAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AddNonZeroAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

AddNonZeroAllKeysOffset

Add source color to target where color is not black for the source frame and target offset frame, reference source and target by id.

ChromaAnimationAPI.AddNonZeroAllKeysOffset(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, offset As Integer)

AddNonZeroAllKeysOffsetName

Add source color to target where color is not black for the source frame and target offset frame, reference source and target by name.

ChromaAnimationAPI.AddNonZeroAllKeysOffsetName(sourceAnimation As String, targetAnimation As String, frameId As Integer, offset As Integer)

AddNonZeroAllKeysOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AddNonZeroAllKeysOffsetNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, offset As Double)

AddNonZeroTargetAllKeysAllFrames

Add source color to target where the target color is not black for all frames, reference source and target by id.

ChromaAnimationAPI.AddNonZeroTargetAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

AddNonZeroTargetAllKeysAllFramesName

Add source color to target where the target color is not black for all frames, reference source and target by name.

ChromaAnimationAPI.AddNonZeroTargetAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

AddNonZeroTargetAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AddNonZeroTargetAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

AddNonZeroTargetAllKeysAllFramesOffset

Add source color to target where the target color is not black for all frames starting at offset for the length of the source, reference source and target by id.

ChromaAnimationAPI.AddNonZeroTargetAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

AddNonZeroTargetAllKeysAllFramesOffsetName

Add source color to target where the target color is not black for all frames starting at offset for the length of the source, reference source and target by name.

ChromaAnimationAPI.AddNonZeroTargetAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

AddNonZeroTargetAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AddNonZeroTargetAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

AddNonZeroTargetAllKeysOffset

Add source color to target where target color is not blank from the source frame to the target offset frame, reference source and target by id.

ChromaAnimationAPI.AddNonZeroTargetAllKeysOffset(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, offset As Integer)

AddNonZeroTargetAllKeysOffsetName

Add source color to target where target color is not blank from the source frame to the target offset frame, reference source and target by name.

ChromaAnimationAPI.AddNonZeroTargetAllKeysOffsetName(sourceAnimation As String, targetAnimation As String, frameId As Integer, offset As Integer)

AddNonZeroTargetAllKeysOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AddNonZeroTargetAllKeysOffsetNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, offset As Double)

AppendAllFrames

Append all source frames to the target animation, reference source and target by id.

ChromaAnimationAPI.AppendAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

AppendAllFramesName

Append all source frames to the target animation, reference source and target by name.

ChromaAnimationAPI.AppendAllFramesName(sourceAnimation As String, targetAnimation As String)

AppendAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.AppendAllFramesNameD(sourceAnimation As String, targetAnimation As String)

ClearAll

PluginClearAll will issue a CLEAR effect for all devices.

ChromaAnimationAPI.ClearAll()

ClearAnimationType

PluginClearAnimationType will issue a CLEAR effect for the given device.

ChromaAnimationAPI.ClearAnimationType(deviceType As Integer, device As Integer)

CloseAll

PluginCloseAll closes all open animations so they can be reloaded from disk. The set of animations will be stopped if playing.

ChromaAnimationAPI.CloseAll()

CloseAnimation

Closes the Chroma animation to free up resources referenced by id. Returns the animation id upon success. Returns -1 upon failure. This might be used while authoring effects if there was a change necessitating re-opening the animation. The animation id can no longer be used once closed.

Dim result As Integer = ChromaAnimationAPI.CloseAnimation(animationId As Integer)

CloseAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CloseAnimationD(animationId As Double)

CloseAnimationName

Closes the Chroma animation referenced by name so that the animation can be reloaded from disk.

ChromaAnimationAPI.CloseAnimationName(path As String)

CloseAnimationNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CloseAnimationNameD(path As String)

CloseComposite

PluginCloseComposite closes a set of animations so they can be reloaded from disk. The set of animations will be stopped if playing.

ChromaAnimationAPI.CloseComposite(name As String)

CloseCompositeD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CloseCompositeD(name As String)

CopyAllKeys

Copy source animation to target animation for the given frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyAllKeys(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer)

CopyAllKeysName

Copy source animation to target animation for the given frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyAllKeysName(sourceAnimation As String, targetAnimation As String, frameId As Integer)

CopyAnimation

Copy animation to named target animation in memory. If target animation exists, close first. Source is referenced by id.

Dim result As Integer = ChromaAnimationAPI.CopyAnimation(sourceAnimationId As Integer, targetAnimation As String)

CopyAnimationName

Copy animation to named target animation in memory. If target animation exists, close first. Source is referenced by name.

ChromaAnimationAPI.CopyAnimationName(sourceAnimation As String, targetAnimation As String)

CopyAnimationNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyAnimationNameD(sourceAnimation As String, targetAnimation As String)

CopyBlueChannelAllFrames

Copy blue channel to other channels for all frames. Intensity range is 0.0 to 1.0. Reference the animation by id.

ChromaAnimationAPI.CopyBlueChannelAllFrames(animationId As Integer, redIntensity As Single, greenIntensity As Single)

CopyBlueChannelAllFramesName

Copy blue channel to other channels for all frames. Intensity range is 0.0 to 1.0. Reference the animation by name.

ChromaAnimationAPI.CopyBlueChannelAllFramesName(path As String, redIntensity As Single, greenIntensity As Single)

CopyBlueChannelAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyBlueChannelAllFramesNameD(path As String, redIntensity As Double, greenIntensity As Double)

CopyGreenChannelAllFrames

Copy green channel to other channels for all frames. Intensity range is 0.0 to 1.0. Reference the animation by id.

ChromaAnimationAPI.CopyGreenChannelAllFrames(animationId As Integer, redIntensity As Single, blueIntensity As Single)

CopyGreenChannelAllFramesName

Copy green channel to other channels for all frames. Intensity range is 0.0 to 1.0. Reference the animation by name.

ChromaAnimationAPI.CopyGreenChannelAllFramesName(path As String, redIntensity As Single, blueIntensity As Single)

CopyGreenChannelAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyGreenChannelAllFramesNameD(path As String, redIntensity As Double, blueIntensity As Double)

CopyKeyColor

Copy animation key color from the source animation to the target animation for the given frame. Reference the source and target by id.

ChromaAnimationAPI.CopyKeyColor(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, rzkey As Integer)

CopyKeyColorAllFrames

Copy animation key color from the source animation to the target animation for all frames. Reference the source and target by id.

ChromaAnimationAPI.CopyKeyColorAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer, rzkey As Integer)

CopyKeyColorAllFramesName

Copy animation key color from the source animation to the target animation for all frames. Reference the source and target by name.

ChromaAnimationAPI.CopyKeyColorAllFramesName(sourceAnimation As String, targetAnimation As String, rzkey As Integer)

CopyKeyColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyKeyColorAllFramesNameD(sourceAnimation As String, targetAnimation As String, rzkey As Double)

CopyKeyColorAllFramesOffset

Copy animation key color from the source animation to the target animation for all frames, starting at the offset for the length of the source animation. Source and target are referenced by id.

ChromaAnimationAPI.CopyKeyColorAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, rzkey As Integer, offset As Integer)

CopyKeyColorAllFramesOffsetName

Copy animation key color from the source animation to the target animation for all frames, starting at the offset for the length of the source animation. Source and target are referenced by name.

ChromaAnimationAPI.CopyKeyColorAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, rzkey As Integer, offset As Integer)

CopyKeyColorAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyKeyColorAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, rzkey As Double, offset As Double)

CopyKeyColorName

Copy animation key color from the source animation to the target animation for the given frame.

ChromaAnimationAPI.CopyKeyColorName(sourceAnimation As String, targetAnimation As String, frameId As Integer, rzkey As Integer)

CopyKeyColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyKeyColorNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, rzkey As Double)

CopyKeysColor

Copy animation color for a set of keys from the source animation to the target animation for the given frame. Reference the source and target by id.

ChromaAnimationAPI.CopyKeysColor(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, keys As Integer(), size As Integer)

CopyKeysColorAllFrames

Copy animation color for a set of keys from the source animation to the target animation for all frames. Reference the source and target by id.

ChromaAnimationAPI.CopyKeysColorAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer, keys As Integer(), size As Integer)

CopyKeysColorAllFramesName

Copy animation color for a set of keys from the source animation to the target animation for all frames. Reference the source and target by name.

ChromaAnimationAPI.CopyKeysColorAllFramesName(sourceAnimation As String, targetAnimation As String, keys As Integer(), size As Integer)

CopyKeysColorName

Copy animation color for a set of keys from the source animation to the target animation for the given frame. Reference the source and target by name.

ChromaAnimationAPI.CopyKeysColorName(sourceAnimation As String, targetAnimation As String, frameId As Integer, keys As Integer(), size As Integer)

CopyKeysColorOffset

Copy animation color for a set of keys from the source animation to the target animation from the source frame to the target frame. Reference the source and target by id.

ChromaAnimationAPI.CopyKeysColorOffset(sourceAnimationId As Integer, targetAnimationId As Integer, sourceFrameId As Integer, targetFrameId As Integer, keys As Integer(), size As Integer)

CopyKeysColorOffsetName

Copy animation color for a set of keys from the source animation to the target animation from the source frame to the target frame. Reference the source and target by name.

ChromaAnimationAPI.CopyKeysColorOffsetName(sourceAnimation As String, targetAnimation As String, sourceFrameId As Integer, targetFrameId As Integer, keys As Integer(), size As Integer)

CopyNonZeroAllKeys

Copy source animation to target animation for the given frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroAllKeys(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer)

CopyNonZeroAllKeysAllFrames

Copy nonzero colors from a source animation to a target animation for all frames. Reference source and target by id.

ChromaAnimationAPI.CopyNonZeroAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

CopyNonZeroAllKeysAllFramesName

Copy nonzero colors from a source animation to a target animation for all frames. Reference source and target by name.

ChromaAnimationAPI.CopyNonZeroAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

CopyNonZeroAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

CopyNonZeroAllKeysAllFramesOffset

Copy nonzero colors from a source animation to a target animation for all frames starting at the offset for the length of the source animation. The source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

CopyNonZeroAllKeysAllFramesOffsetName

Copy nonzero colors from a source animation to a target animation for all frames starting at the offset for the length of the source animation. The source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

CopyNonZeroAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

CopyNonZeroAllKeysName

Copy nonzero colors from source animation to target animation for the specified frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroAllKeysName(sourceAnimation As String, targetAnimation As String, frameId As Integer)

CopyNonZeroAllKeysNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroAllKeysNameD(sourceAnimation As String, targetAnimation As String, frameId As Double)

CopyNonZeroAllKeysOffset

Copy nonzero colors from the source animation to the target animation from the source frame to the target offset frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroAllKeysOffset(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, offset As Integer)

CopyNonZeroAllKeysOffsetName

Copy nonzero colors from the source animation to the target animation from the source frame to the target offset frame. Source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroAllKeysOffsetName(sourceAnimation As String, targetAnimation As String, frameId As Integer, offset As Integer)

CopyNonZeroAllKeysOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroAllKeysOffsetNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, offset As Double)

CopyNonZeroKeyColor

Copy animation key color from the source animation to the target animation for the given frame where color is not zero.

ChromaAnimationAPI.CopyNonZeroKeyColor(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, rzkey As Integer)

CopyNonZeroKeyColorName

Copy animation key color from the source animation to the target animation for the given frame where color is not zero.

ChromaAnimationAPI.CopyNonZeroKeyColorName(sourceAnimation As String, targetAnimation As String, frameId As Integer, rzkey As Integer)

CopyNonZeroKeyColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroKeyColorNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, rzkey As Double)

CopyNonZeroTargetAllKeys

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for the specified frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroTargetAllKeys(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer)

CopyNonZeroTargetAllKeysAllFrames

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for all frames. Source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

CopyNonZeroTargetAllKeysAllFramesName

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for all frames. Source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

CopyNonZeroTargetAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroTargetAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

CopyNonZeroTargetAllKeysAllFramesOffset

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for all frames. Source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

CopyNonZeroTargetAllKeysAllFramesOffsetName

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for all frames starting at the target offset for the length of the source animation. Source and target animations are referenced by name.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

CopyNonZeroTargetAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroTargetAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

CopyNonZeroTargetAllKeysName

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for the specified frame. The source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysName(sourceAnimation As String, targetAnimation As String, frameId As Integer)

CopyNonZeroTargetAllKeysNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroTargetAllKeysNameD(sourceAnimation As String, targetAnimation As String, frameId As Double)

CopyNonZeroTargetAllKeysOffset

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for the specified source frame and target offset frame. The source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysOffset(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, offset As Integer)

CopyNonZeroTargetAllKeysOffsetName

Copy nonzero colors from the source animation to the target animation where the target color is nonzero for the specified source frame and target offset frame. The source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroTargetAllKeysOffsetName(sourceAnimation As String, targetAnimation As String, frameId As Integer, offset As Integer)

CopyNonZeroTargetAllKeysOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroTargetAllKeysOffsetNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, offset As Double)

CopyNonZeroTargetZeroAllKeysAllFrames

Copy nonzero colors from the source animation to the target animation where the target color is zero for all frames. Source and target are referenced by id.

ChromaAnimationAPI.CopyNonZeroTargetZeroAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

CopyNonZeroTargetZeroAllKeysAllFramesName

Copy nonzero colors from the source animation to the target animation where the target color is zero for all frames. Source and target are referenced by name.

ChromaAnimationAPI.CopyNonZeroTargetZeroAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

CopyNonZeroTargetZeroAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyNonZeroTargetZeroAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

CopyRedChannelAllFrames

Copy red channel to other channels for all frames. Intensity range is 0.0 to 1.0. Reference the animation by id.

ChromaAnimationAPI.CopyRedChannelAllFrames(animationId As Integer, greenIntensity As Single, blueIntensity As Single)

CopyRedChannelAllFramesName

Copy green channel to other channels for all frames. Intensity range is 0.0 to 1.0. Reference the animation by name.

ChromaAnimationAPI.CopyRedChannelAllFramesName(path As String, greenIntensity As Single, blueIntensity As Single)

CopyRedChannelAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyRedChannelAllFramesNameD(path As String, greenIntensity As Double, blueIntensity As Double)

CopyZeroAllKeysAllFrames

Copy zero colors from source animation to target animation for all frames. Source and target are referenced by id.

ChromaAnimationAPI.CopyZeroAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

CopyZeroAllKeysAllFramesName

Copy zero colors from source animation to target animation for all frames. Source and target are referenced by name.

ChromaAnimationAPI.CopyZeroAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

CopyZeroAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyZeroAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

CopyZeroAllKeysAllFramesOffset

Copy zero colors from source animation to target animation for all frames starting at the target offset for the length of the source animation. Source and target are referenced by id.

ChromaAnimationAPI.CopyZeroAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

CopyZeroAllKeysAllFramesOffsetName

Copy zero colors from source animation to target animation for all frames starting at the target offset for the length of the source animation. Source and target are referenced by name.

ChromaAnimationAPI.CopyZeroAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

CopyZeroAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyZeroAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

CopyZeroKeyColor

Copy zero key color from source animation to target animation for the specified frame. Source and target are referenced by id.

ChromaAnimationAPI.CopyZeroKeyColor(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, rzkey As Integer)

CopyZeroKeyColorName

Copy zero key color from source animation to target animation for the specified frame. Source and target are referenced by name.

ChromaAnimationAPI.CopyZeroKeyColorName(sourceAnimation As String, targetAnimation As String, frameId As Integer, rzkey As Integer)

CopyZeroKeyColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyZeroKeyColorNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, rzkey As Double)

CopyZeroTargetAllKeysAllFrames

Copy nonzero color from source animation to target animation where target is zero for all frames. Source and target are referenced by id.

ChromaAnimationAPI.CopyZeroTargetAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

CopyZeroTargetAllKeysAllFramesName

Copy nonzero color from source animation to target animation where target is zero for all frames. Source and target are referenced by name.

ChromaAnimationAPI.CopyZeroTargetAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

CopyZeroTargetAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.CopyZeroTargetAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

CoreCreateChromaLinkEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateChromaLinkEffect(effect As Integer, pParam As IntPtr, ByRef pEffectId As Guid)

CoreCreateEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateEffect(deviceId As Guid, effect As EFFECT_TYPE, pParam As IntPtr, ByRef pEffectId As Guid)

CoreCreateHeadsetEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateHeadsetEffect(effect As Integer, pParam As IntPtr, ByRef pEffectId As Guid)

CoreCreateKeyboardEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateKeyboardEffect(effect As Integer, pParam As IntPtr, ByRef pEffectId As Guid)

CoreCreateKeypadEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateKeypadEffect(effect As Integer, pParam As IntPtr, ByRef pEffectId As Guid)

CoreCreateMouseEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateMouseEffect(effect As Integer, pParam As IntPtr, ByRef pEffectId As Guid)

CoreCreateMousepadEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreCreateMousepadEffect(effect As Integer, pParam As IntPtr, ByRef pEffectId As Guid)

CoreDeleteEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreDeleteEffect(effectId As Guid)

CoreInit

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreInit()

CoreInitSDK

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreInitSDK(ByRef appInfo As ChromaSDK.APPINFOTYPE)

CoreQueryDevice

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreQueryDevice(deviceId As Guid, ByRef deviceInfo As DEVICE_INFO_TYPE)

CoreSetEffect

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreSetEffect(effectId As Guid)

CoreStreamBroadcast

Begin broadcasting Chroma RGB data using the stored stream key as the endpoint. Intended for Cloud Gaming Platforms, restore the streaming key when the game instance is launched to continue streaming. streamId is a null terminated string streamKey is a null terminated string StreamGetStatus() should return the READY status to use this method.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamBroadcast(streamId As String, streamKey As String)

CoreStreamBroadcastEnd

End broadcasting Chroma RGB data. StreamGetStatus() should return the BROADCASTING status to use this method.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamBroadcastEnd()

CoreStreamGetAuthShortcode

shortcode: Pass the address of a preallocated character buffer to get the streaming auth code. The buffer should have a minimum length of 6. length: Length will return as zero if the streaming auth code could not be obtained. If length is greater than zero, it will be the length of the returned streaming auth code. Once you have the shortcode, it should be shown to the user so they can associate the stream with their Razer ID StreamGetStatus() should return the READY status before invoking this method.

ChromaAnimationAPI.CoreStreamGetAuthShortcode(ByRef shortcode As String, ByRef length As byte, platform As String, title As String)

CoreStreamGetFocus

focus: Pass the address of a preallocated character buffer to get the stream focus. The buffer should have a length of 48 length: Length will return as zero if the stream focus could not be obtained. If length is greater than zero, it will be the length of the returned stream focus.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamGetFocus(ByRef focus As String, ByRef length As byte)

CoreStreamGetId

Intended for Cloud Gaming Platforms, store the stream id to persist in user preferences to continue streaming if the game is suspended or closed. shortcode: The shortcode is a null terminated string. Use the shortcode that authorized the stream to obtain the stream id. streamId should be a preallocated buffer to get the stream key. The buffer should have a length of 48. length: Length will return zero if the key could not be obtained. If the length is greater than zero, it will be the length of the returned streaming id. Retrieve the stream id after authorizing the shortcode. The authorization window will expire in 5 minutes. Be sure to save the stream key before the window expires. platform: is the null terminated string that identifies the source of the stream: { GEFORCE_NOW, LUNA, STADIA, GAME_PASS } StreamGetStatus() should return the READY status to use this method.

ChromaAnimationAPI.CoreStreamGetId(shortcode As String, ByRef streamId As String, ByRef length As byte)

CoreStreamGetKey

Intended for Cloud Gaming Platforms, store the streaming key to persist in user preferences to continue streaming if the game is suspended or closed. shortcode: The shortcode is a null terminated string. Use the shortcode that authorized the stream to obtain the stream key. If the status is in the BROADCASTING or WATCHING state, passing a NULL shortcode will return the active streamId. streamKey should be a preallocated buffer to get the stream key. The buffer should have a length of 48. length: Length will return zero if the key could not be obtained. If the length is greater than zero, it will be the length of the returned streaming key. Retrieve the stream key after authorizing the shortcode. The authorization window will expire in 5 minutes. Be sure to save the stream key before the window expires. StreamGetStatus() should return the READY status to use this method.

ChromaAnimationAPI.CoreStreamGetKey(shortcode As String, ByRef streamKey As String, ByRef length As byte)

CoreStreamGetStatus

Returns StreamStatus, the current status of the service

Dim result As ChromaSDK.Stream.StreamStatusType = ChromaAnimationAPI.CoreStreamGetStatus()

CoreStreamGetStatusString

Convert StreamStatusType to a printable string

Dim result As String = ChromaAnimationAPI.CoreStreamGetStatusString(status As ChromaSDK.Stream.StreamStatusType)

CoreStreamReleaseShortcode

This prevents the stream id and stream key from being obtained through the shortcode. This closes the auth window. shortcode is a null terminated string. StreamGetStatus() should return the READY status to use this method. returns success when shortcode has been released

Dim result As Boolean = ChromaAnimationAPI.CoreStreamReleaseShortcode(shortcode As String)

CoreStreamSetFocus

The focus is a null terminated string. Set the focus identifer for the application designated to automatically change the streaming state. Returns true on success.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamSetFocus(focus As String)

CoreStreamSupportsStreaming

Returns true if the Chroma streaming is supported. If false is returned, avoid calling stream methods.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamSupportsStreaming()

CoreStreamWatch

Begin watching the Chroma RGB data using streamID parameter. streamId is a null terminated string. StreamGetStatus() should return the READY status to use this method.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamWatch(streamId As String, timestamp As ulong)

CoreStreamWatchEnd

End watching Chroma RGB data stream. StreamGetStatus() should return the WATCHING status to use this method.

Dim result As Boolean = ChromaAnimationAPI.CoreStreamWatchEnd()

CoreUnInit

Direct access to low level API.

Dim result As Integer = ChromaAnimationAPI.CoreUnInit()

CreateAnimation

Creates a Chroma animation at the given path. The deviceType parameter uses EChromaSDKDeviceTypeEnum as an integer. The device parameter uses EChromaSDKDevice1DEnum or EChromaSDKDevice2DEnum as an integer, respective to the deviceType. Returns the animation id upon success. Returns -1 upon failure. Saves a Chroma animation file with the .chroma extension at the given path. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.CreateAnimation(path As String, deviceType As Integer, device As Integer)

CreateAnimationInMemory

Creates a Chroma animation in memory without creating a file. The deviceType parameter uses EChromaSDKDeviceTypeEnum as an integer. The device parameter uses EChromaSDKDevice1DEnum or EChromaSDKDevice2DEnum as an integer, respective to the deviceType. Returns the animation id upon success. Returns -1 upon failure. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.CreateAnimationInMemory(deviceType As Integer, device As Integer)

CreateEffect

Create a device specific effect.

Dim result As Integer = ChromaAnimationAPI.CreateEffect(deviceId As Guid, effect As EFFECT_TYPE, colors As Integer(), size As Integer, ByRef effectId As FChromaSDKGuid)

DeleteEffect

Delete an effect given the effect id.

Dim result As Integer = ChromaAnimationAPI.DeleteEffect(effectId As Guid)

DuplicateFirstFrame

Duplicate the first animation frame so that the animation length matches the frame count. Animation is referenced by id.

ChromaAnimationAPI.DuplicateFirstFrame(animationId As Integer, frameCount As Integer)

DuplicateFirstFrameName

Duplicate the first animation frame so that the animation length matches the frame count. Animation is referenced by name.

ChromaAnimationAPI.DuplicateFirstFrameName(path As String, frameCount As Integer)

DuplicateFirstFrameNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.DuplicateFirstFrameNameD(path As String, frameCount As Double)

DuplicateFrames

Duplicate all the frames of the animation to double the animation length. Frame 1 becomes frame 1 and 2. Frame 2 becomes frame 3 and 4. And so on. The animation is referenced by id.

ChromaAnimationAPI.DuplicateFrames(animationId As Integer)

DuplicateFramesName

Duplicate all the frames of the animation to double the animation length. Frame 1 becomes frame 1 and 2. Frame 2 becomes frame 3 and 4. And so on. The animation is referenced by name.

ChromaAnimationAPI.DuplicateFramesName(path As String)

DuplicateFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.DuplicateFramesNameD(path As String)

DuplicateMirrorFrames

Duplicate all the animation frames in reverse so that the animation plays forwards and backwards. Animation is referenced by id.

ChromaAnimationAPI.DuplicateMirrorFrames(animationId As Integer)

DuplicateMirrorFramesName

Duplicate all the animation frames in reverse so that the animation plays forwards and backwards. Animation is referenced by name.

ChromaAnimationAPI.DuplicateMirrorFramesName(path As String)

DuplicateMirrorFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.DuplicateMirrorFramesNameD(path As String)

FadeEndFrames

Fade the animation to black starting at the fade frame index to the end of the animation. Animation is referenced by id.

ChromaAnimationAPI.FadeEndFrames(animationId As Integer, fade As Integer)

FadeEndFramesName

Fade the animation to black starting at the fade frame index to the end of the animation. Animation is referenced by name.

ChromaAnimationAPI.FadeEndFramesName(path As String, fade As Integer)

FadeEndFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FadeEndFramesNameD(path As String, fade As Double)

FadeStartFrames

Fade the animation from black to full color starting at 0 to the fade frame index. Animation is referenced by id.

ChromaAnimationAPI.FadeStartFrames(animationId As Integer, fade As Integer)

FadeStartFramesName

Fade the animation from black to full color starting at 0 to the fade frame index. Animation is referenced by name.

ChromaAnimationAPI.FadeStartFramesName(path As String, fade As Integer)

FadeStartFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FadeStartFramesNameD(path As String, fade As Double)

FillColor

Set the RGB value for all colors in the specified frame. Animation is referenced by id.

ChromaAnimationAPI.FillColor(animationId As Integer, frameId As Integer, color As Integer)

FillColorAllFrames

Set the RGB value for all colors for all frames. Animation is referenced by id.

ChromaAnimationAPI.FillColorAllFrames(animationId As Integer, color As Integer)

FillColorAllFramesName

Set the RGB value for all colors for all frames. Animation is referenced by name.

ChromaAnimationAPI.FillColorAllFramesName(path As String, color As Integer)

FillColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillColorAllFramesNameD(path As String, color As Double)

FillColorAllFramesRGB

Set the RGB value for all colors for all frames. Use the range of 0 to 255 for red, green, and blue parameters. Animation is referenced by id.

ChromaAnimationAPI.FillColorAllFramesRGB(animationId As Integer, red As Integer, green As Integer, blue As Integer)

FillColorAllFramesRGBName

Set the RGB value for all colors for all frames. Use the range of 0 to 255 for red, green, and blue parameters. Animation is referenced by name.

ChromaAnimationAPI.FillColorAllFramesRGBName(path As String, red As Integer, green As Integer, blue As Integer)

FillColorAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillColorAllFramesRGBNameD(path As String, red As Double, green As Double, blue As Double)

FillColorName

Set the RGB value for all colors in the specified frame. Animation is referenced by name.

ChromaAnimationAPI.FillColorName(path As String, frameId As Integer, color As Integer)

FillColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillColorNameD(path As String, frameId As Double, color As Double)

FillColorRGB

Set the RGB value for all colors in the specified frame. Animation is referenced by id.

ChromaAnimationAPI.FillColorRGB(animationId As Integer, frameId As Integer, red As Integer, green As Integer, blue As Integer)

FillColorRGBName

Set the RGB value for all colors in the specified frame. Animation is referenced by name.

ChromaAnimationAPI.FillColorRGBName(path As String, frameId As Integer, red As Integer, green As Integer, blue As Integer)

FillColorRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillColorRGBNameD(path As String, frameId As Double, red As Double, green As Double, blue As Double)

FillNonZeroColor

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors in the specified frame. Animation is referenced by id.

ChromaAnimationAPI.FillNonZeroColor(animationId As Integer, frameId As Integer, color As Integer)

FillNonZeroColorAllFrames

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors for all frames. Animation is referenced by id.

ChromaAnimationAPI.FillNonZeroColorAllFrames(animationId As Integer, color As Integer)

FillNonZeroColorAllFramesName

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors for all frames. Animation is referenced by name.

ChromaAnimationAPI.FillNonZeroColorAllFramesName(path As String, color As Integer)

FillNonZeroColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillNonZeroColorAllFramesNameD(path As String, color As Double)

FillNonZeroColorAllFramesRGB

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors for all frames. Use the range of 0 to 255 for red, green, and blue parameters. Animation is referenced by id.

ChromaAnimationAPI.FillNonZeroColorAllFramesRGB(animationId As Integer, red As Integer, green As Integer, blue As Integer)

FillNonZeroColorAllFramesRGBName

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors for all frames. Use the range of 0 to 255 for red, green, and blue parameters. Animation is referenced by name.

ChromaAnimationAPI.FillNonZeroColorAllFramesRGBName(path As String, red As Integer, green As Integer, blue As Integer)

FillNonZeroColorAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillNonZeroColorAllFramesRGBNameD(path As String, red As Double, green As Double, blue As Double)

FillNonZeroColorName

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors in the specified frame. Animation is referenced by name.

ChromaAnimationAPI.FillNonZeroColorName(path As String, frameId As Integer, color As Integer)

FillNonZeroColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillNonZeroColorNameD(path As String, frameId As Double, color As Double)

FillNonZeroColorRGB

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors in the specified frame. Use the range of 0 to 255 for red, green, and blue parameters. Animation is referenced by id.

ChromaAnimationAPI.FillNonZeroColorRGB(animationId As Integer, frameId As Integer, red As Integer, green As Integer, blue As Integer)

FillNonZeroColorRGBName

This method will only update colors in the animation that are not already set to black. Set the RGB value for a subset of colors in the specified frame. Use the range of 0 to 255 for red, green, and blue parameters. Animation is referenced by name.

ChromaAnimationAPI.FillNonZeroColorRGBName(path As String, frameId As Integer, red As Integer, green As Integer, blue As Integer)

FillNonZeroColorRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillNonZeroColorRGBNameD(path As String, frameId As Double, red As Double, green As Double, blue As Double)

FillRandomColors

Fill the frame with random RGB values for the given frame. Animation is referenced by id.

ChromaAnimationAPI.FillRandomColors(animationId As Integer, frameId As Integer)

FillRandomColorsAllFrames

Fill the frame with random RGB values for all frames. Animation is referenced by id.

ChromaAnimationAPI.FillRandomColorsAllFrames(animationId As Integer)

FillRandomColorsAllFramesName

Fill the frame with random RGB values for all frames. Animation is referenced by name.

ChromaAnimationAPI.FillRandomColorsAllFramesName(path As String)

FillRandomColorsAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillRandomColorsAllFramesNameD(path As String)

FillRandomColorsBlackAndWhite

Fill the frame with random black and white values for the specified frame. Animation is referenced by id.

ChromaAnimationAPI.FillRandomColorsBlackAndWhite(animationId As Integer, frameId As Integer)

FillRandomColorsBlackAndWhiteAllFrames

Fill the frame with random black and white values for all frames. Animation is referenced by id.

ChromaAnimationAPI.FillRandomColorsBlackAndWhiteAllFrames(animationId As Integer)

FillRandomColorsBlackAndWhiteAllFramesName

Fill the frame with random black and white values for all frames. Animation is referenced by name.

ChromaAnimationAPI.FillRandomColorsBlackAndWhiteAllFramesName(path As String)

FillRandomColorsBlackAndWhiteAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillRandomColorsBlackAndWhiteAllFramesNameD(path As String)

FillRandomColorsBlackAndWhiteName

Fill the frame with random black and white values for the specified frame. Animation is referenced by name.

ChromaAnimationAPI.FillRandomColorsBlackAndWhiteName(path As String, frameId As Integer)

FillRandomColorsBlackAndWhiteNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillRandomColorsBlackAndWhiteNameD(path As String, frameId As Double)

FillRandomColorsName

Fill the frame with random RGB values for the given frame. Animation is referenced by name.

ChromaAnimationAPI.FillRandomColorsName(path As String, frameId As Integer)

FillRandomColorsNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillRandomColorsNameD(path As String, frameId As Double)

FillThresholdColors

Fill the specified frame with RGB color where the animation color is less than the RGB threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdColors(animationId As Integer, frameId As Integer, threshold As Integer, color As Integer)

FillThresholdColorsAllFrames

Fill all frames with RGB color where the animation color is less than the RGB threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdColorsAllFrames(animationId As Integer, threshold As Integer, color As Integer)

FillThresholdColorsAllFramesName

Fill all frames with RGB color where the animation color is less than the RGB threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdColorsAllFramesName(path As String, threshold As Integer, color As Integer)

FillThresholdColorsAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdColorsAllFramesNameD(path As String, threshold As Double, color As Double)

FillThresholdColorsAllFramesRGB

Fill all frames with RGB color where the animation color is less than the threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdColorsAllFramesRGB(animationId As Integer, threshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdColorsAllFramesRGBName

Fill all frames with RGB color where the animation color is less than the threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdColorsAllFramesRGBName(path As String, threshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdColorsAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdColorsAllFramesRGBNameD(path As String, threshold As Double, red As Double, green As Double, blue As Double)

FillThresholdColorsMinMaxAllFramesRGB

Fill all frames with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdColorsMinMaxAllFramesRGB(animationId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

FillThresholdColorsMinMaxAllFramesRGBName

Fill all frames with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdColorsMinMaxAllFramesRGBName(path As String, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

FillThresholdColorsMinMaxAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdColorsMinMaxAllFramesRGBNameD(path As String, minThreshold As Double, minRed As Double, minGreen As Double, minBlue As Double, maxThreshold As Double, maxRed As Double, maxGreen As Double, maxBlue As Double)

FillThresholdColorsMinMaxRGB

Fill the specified frame with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdColorsMinMaxRGB(animationId As Integer, frameId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

FillThresholdColorsMinMaxRGBName

Fill the specified frame with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdColorsMinMaxRGBName(path As String, frameId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

FillThresholdColorsMinMaxRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdColorsMinMaxRGBNameD(path As String, frameId As Double, minThreshold As Double, minRed As Double, minGreen As Double, minBlue As Double, maxThreshold As Double, maxRed As Double, maxGreen As Double, maxBlue As Double)

FillThresholdColorsName

Fill the specified frame with RGB color where the animation color is less than the RGB threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdColorsName(path As String, frameId As Integer, threshold As Integer, color As Integer)

FillThresholdColorsNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdColorsNameD(path As String, frameId As Double, threshold As Double, color As Double)

FillThresholdColorsRGB

Fill the specified frame with RGB color where the animation color is less than the RGB threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdColorsRGB(animationId As Integer, frameId As Integer, threshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdColorsRGBName

Fill the specified frame with RGB color where the animation color is less than the RGB threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdColorsRGBName(path As String, frameId As Integer, threshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdColorsRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdColorsRGBNameD(path As String, frameId As Double, threshold As Double, red As Double, green As Double, blue As Double)

FillThresholdRGBColorsAllFramesRGB

Fill all frames with RGB color where the animation color is less than the RGB threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdRGBColorsAllFramesRGB(animationId As Integer, redThreshold As Integer, greenThreshold As Integer, blueThreshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdRGBColorsAllFramesRGBName

Fill all frames with RGB color where the animation color is less than the RGB threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdRGBColorsAllFramesRGBName(path As String, redThreshold As Integer, greenThreshold As Integer, blueThreshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdRGBColorsAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdRGBColorsAllFramesRGBNameD(path As String, redThreshold As Double, greenThreshold As Double, blueThreshold As Double, red As Double, green As Double, blue As Double)

FillThresholdRGBColorsRGB

Fill the specified frame with RGB color where the animation color is less than the RGB threshold. Animation is referenced by id.

ChromaAnimationAPI.FillThresholdRGBColorsRGB(animationId As Integer, frameId As Integer, redThreshold As Integer, greenThreshold As Integer, blueThreshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdRGBColorsRGBName

Fill the specified frame with RGB color where the animation color is less than the RGB threshold. Animation is referenced by name.

ChromaAnimationAPI.FillThresholdRGBColorsRGBName(path As String, frameId As Integer, redThreshold As Integer, greenThreshold As Integer, blueThreshold As Integer, red As Integer, green As Integer, blue As Integer)

FillThresholdRGBColorsRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillThresholdRGBColorsRGBNameD(path As String, frameId As Double, redThreshold As Double, greenThreshold As Double, blueThreshold As Double, red As Double, green As Double, blue As Double)

FillZeroColor

Fill the specified frame with RGB color where the animation color is zero. Animation is referenced by id.

ChromaAnimationAPI.FillZeroColor(animationId As Integer, frameId As Integer, color As Integer)

FillZeroColorAllFrames

Fill all frames with RGB color where the animation color is zero. Animation is referenced by id.

ChromaAnimationAPI.FillZeroColorAllFrames(animationId As Integer, color As Integer)

FillZeroColorAllFramesName

Fill all frames with RGB color where the animation color is zero. Animation is referenced by name.

ChromaAnimationAPI.FillZeroColorAllFramesName(path As String, color As Integer)

FillZeroColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillZeroColorAllFramesNameD(path As String, color As Double)

FillZeroColorAllFramesRGB

Fill all frames with RGB color where the animation color is zero. Animation is referenced by id.

ChromaAnimationAPI.FillZeroColorAllFramesRGB(animationId As Integer, red As Integer, green As Integer, blue As Integer)

FillZeroColorAllFramesRGBName

Fill all frames with RGB color where the animation color is zero. Animation is referenced by name.

ChromaAnimationAPI.FillZeroColorAllFramesRGBName(path As String, red As Integer, green As Integer, blue As Integer)

FillZeroColorAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillZeroColorAllFramesRGBNameD(path As String, red As Double, green As Double, blue As Double)

FillZeroColorName

Fill the specified frame with RGB color where the animation color is zero. Animation is referenced by name.

ChromaAnimationAPI.FillZeroColorName(path As String, frameId As Integer, color As Integer)

FillZeroColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillZeroColorNameD(path As String, frameId As Double, color As Double)

FillZeroColorRGB

Fill the specified frame with RGB color where the animation color is zero. Animation is referenced by id.

ChromaAnimationAPI.FillZeroColorRGB(animationId As Integer, frameId As Integer, red As Integer, green As Integer, blue As Integer)

FillZeroColorRGBName

Fill the specified frame with RGB color where the animation color is zero. Animation is referenced by name.

ChromaAnimationAPI.FillZeroColorRGBName(path As String, frameId As Integer, red As Integer, green As Integer, blue As Integer)

FillZeroColorRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.FillZeroColorRGBNameD(path As String, frameId As Double, red As Double, green As Double, blue As Double)

Get1DColor

Get the animation color for a frame given the 1D led. The led should be greater than or equal to 0 and less than the MaxLeds. Animation is referenced by id.

Dim result As Integer = ChromaAnimationAPI.Get1DColor(animationId As Integer, frameId As Integer, led As Integer)

Get1DColorName

Get the animation color for a frame given the 1D led. The led should be greater than or equal to 0 and less than the MaxLeds. Animation is referenced by name.

Dim result As Integer = ChromaAnimationAPI.Get1DColorName(path As String, frameId As Integer, led As Integer)

Get1DColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.Get1DColorNameD(path As String, frameId As Double, led As Double)

Get2DColor

Get the animation color for a frame given the 2D row and column. The row should be greater than or equal to 0 and less than the MaxRow. The column should be greater than or equal to 0 and less than the MaxColumn. Animation is referenced by id.

Dim result As Integer = ChromaAnimationAPI.Get2DColor(animationId As Integer, frameId As Integer, row As Integer, column As Integer)

Get2DColorName

Get the animation color for a frame given the 2D row and column. The row should be greater than or equal to 0 and less than the MaxRow. The column should be greater than or equal to 0 and less than the MaxColumn. Animation is referenced by name.

Dim result As Integer = ChromaAnimationAPI.Get2DColorName(path As String, frameId As Integer, row As Integer, column As Integer)

Get2DColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.Get2DColorNameD(path As String, frameId As Double, row As Double, column As Double)

GetAnimation

Get the animation id for the named animation.

Dim result As Integer = ChromaAnimationAPI.GetAnimation(name As String)

GetAnimationCount

PluginGetAnimationCount will return the number of loaded animations.

Dim result As Integer = ChromaAnimationAPI.GetAnimationCount()

GetAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetAnimationD(name As String)

GetAnimationId

PluginGetAnimationId will return the animationId given the index of the loaded animation. The index is zero-based and less than the number returned by PluginGetAnimationCount. Use PluginGetAnimationName to get the name of the animation.

Dim result As Integer = ChromaAnimationAPI.GetAnimationId(index As Integer)

GetAnimationName

PluginGetAnimationName takes an animationId and returns the name of the animation of the .chroma animation file. If a name is not available then an empty string will be returned.

Dim result As String = ChromaAnimationAPI.GetAnimationName(animationId As Integer)

GetCurrentFrame

Get the current frame of the animation referenced by id.

Dim result As Integer = ChromaAnimationAPI.GetCurrentFrame(animationId As Integer)

GetCurrentFrameName

Get the current frame of the animation referenced by name.

Dim result As Integer = ChromaAnimationAPI.GetCurrentFrameName(path As String)

GetCurrentFrameNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetCurrentFrameNameD(path As String)

GetDevice

Returns the EChromaSDKDevice1DEnum or EChromaSDKDevice2DEnum of a Chroma animation respective to the deviceType, as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetDevice(animationId As Integer)

GetDeviceName

Returns the EChromaSDKDevice1DEnum or EChromaSDKDevice2DEnum of a Chroma animation respective to the deviceType, as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetDeviceName(path As String)

GetDeviceNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetDeviceNameD(path As String)

GetDeviceType

Returns the EChromaSDKDeviceTypeEnum of a Chroma animation as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetDeviceType(animationId As Integer)

GetDeviceTypeName

Returns the EChromaSDKDeviceTypeEnum of a Chroma animation as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetDeviceTypeName(path As String)

GetDeviceTypeNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetDeviceTypeNameD(path As String)

GetFrame

Gets the frame colors and duration (in seconds) for a Chroma animation. The color is expected to be an array of the expected dimensions for the deviceType/device. The length parameter is the size of the color array. For EChromaSDKDevice1DEnum the array size should be MAX LEDS. For EChromaSDKDevice2DEnum the array size should be MAX ROW * MAX COLUMN. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetFrame(animationId As Integer, frameIndex As Integer, ByRef duration As Single, colors As Integer(), length As Integer)

GetFrameCount

Returns the frame count of a Chroma animation upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetFrameCount(animationId As Integer)

GetFrameCountName

Returns the frame count of a Chroma animation upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetFrameCountName(path As String)

GetFrameCountNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetFrameCountNameD(path As String)

GetKeyColor

Get the color of an animation key for the given frame referenced by id.

Dim result As Integer = ChromaAnimationAPI.GetKeyColor(animationId As Integer, frameId As Integer, rzkey As Integer)

GetKeyColorD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetKeyColorD(path As String, frameId As Double, rzkey As Double)

GetKeyColorName

Get the color of an animation key for the given frame referenced by name.

Dim result As Integer = ChromaAnimationAPI.GetKeyColorName(path As String, frameId As Integer, rzkey As Integer)

GetLibraryLoadedState

Returns RZRESULT_SUCCESS if the plugin has been initialized successfully. Returns RZRESULT_DLL_NOT_FOUND if core Chroma library is not found. Returns RZRESULT_DLL_INVALID_SIGNATURE if core Chroma library has an invalid signature.

Dim result As Integer = ChromaAnimationAPI.GetLibraryLoadedState()

GetLibraryLoadedStateD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetLibraryLoadedStateD()

GetMaxColumn

Returns the MAX COLUMN given the EChromaSDKDevice2DEnum device as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetMaxColumn(device As Device2D)

GetMaxColumnD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetMaxColumnD(device As Double)

GetMaxLeds

Returns the MAX LEDS given the EChromaSDKDevice1DEnum device as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetMaxLeds(device As Device1D)

GetMaxLedsD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetMaxLedsD(device As Double)

GetMaxRow

Returns the MAX ROW given the EChromaSDKDevice2DEnum device as an integer upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.GetMaxRow(device As Device2D)

GetMaxRowD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetMaxRowD(device As Double)

GetPlayingAnimationCount

PluginGetPlayingAnimationCount will return the number of playing animations.

Dim result As Integer = ChromaAnimationAPI.GetPlayingAnimationCount()

GetPlayingAnimationId

PluginGetPlayingAnimationId will return the animationId given the index of the playing animation. The index is zero-based and less than the number returned by PluginGetPlayingAnimationCount. Use PluginGetAnimationName to get the name of the animation.

Dim result As Integer = ChromaAnimationAPI.GetPlayingAnimationId(index As Integer)

GetRGB

Get the RGB color given red, green, and blue.

Dim result As Integer = ChromaAnimationAPI.GetRGB(red As Integer, green As Integer, blue As Integer)

GetRGBD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.GetRGBD(red As Double, green As Double, blue As Double)

HasAnimationLoop

Check if the animation has loop enabled referenced by id.

Dim result As Boolean = ChromaAnimationAPI.HasAnimationLoop(animationId As Integer)

HasAnimationLoopName

Check if the animation has loop enabled referenced by name.

Dim result As Boolean = ChromaAnimationAPI.HasAnimationLoopName(path As String)

HasAnimationLoopNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.HasAnimationLoopNameD(path As String)

Init

Initialize the ChromaSDK. Zero indicates success, otherwise failure. Many API methods auto initialize the ChromaSDK if not already initialized.

Dim result As Integer = ChromaAnimationAPI.Init()

InitD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.InitD()

InitSDK

Initialize the ChromaSDK. AppInfo populates the details in Synapse. Zero indicates success, otherwise failure. Many API methods auto initialize the ChromaSDK if not already initialized.

Dim result As Integer = ChromaAnimationAPI.InitSDK(ByRef appInfo As ChromaSDK.APPINFOTYPE)

InsertDelay

Insert an animation delay by duplicating the frame by the delay number of times. Animation is referenced by id.

ChromaAnimationAPI.InsertDelay(animationId As Integer, frameId As Integer, delay As Integer)

InsertDelayName

Insert an animation delay by duplicating the frame by the delay number of times. Animation is referenced by name.

ChromaAnimationAPI.InsertDelayName(path As String, frameId As Integer, delay As Integer)

InsertDelayNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.InsertDelayNameD(path As String, frameId As Double, delay As Double)

InsertFrame

Duplicate the source frame index at the target frame index. Animation is referenced by id.

ChromaAnimationAPI.InsertFrame(animationId As Integer, sourceFrame As Integer, targetFrame As Integer)

InsertFrameName

Duplicate the source frame index at the target frame index. Animation is referenced by name.

ChromaAnimationAPI.InsertFrameName(path As String, sourceFrame As Integer, targetFrame As Integer)

InsertFrameNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.InsertFrameNameD(path As String, sourceFrame As Double, targetFrame As Double)

InvertColors

Invert all the colors at the specified frame. Animation is referenced by id.

ChromaAnimationAPI.InvertColors(animationId As Integer, frameId As Integer)

InvertColorsAllFrames

Invert all the colors for all frames. Animation is referenced by id.

ChromaAnimationAPI.InvertColorsAllFrames(animationId As Integer)

InvertColorsAllFramesName

Invert all the colors for all frames. Animation is referenced by name.

ChromaAnimationAPI.InvertColorsAllFramesName(path As String)

InvertColorsAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.InvertColorsAllFramesNameD(path As String)

InvertColorsName

Invert all the colors at the specified frame. Animation is referenced by name.

ChromaAnimationAPI.InvertColorsName(path As String, frameId As Integer)

InvertColorsNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.InvertColorsNameD(path As String, frameId As Double)

IsAnimationPaused

Check if the animation is paused referenced by id.

Dim result As Boolean = ChromaAnimationAPI.IsAnimationPaused(animationId As Integer)

IsAnimationPausedName

Check if the animation is paused referenced by name.

Dim result As Boolean = ChromaAnimationAPI.IsAnimationPausedName(path As String)

IsAnimationPausedNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsAnimationPausedNameD(path As String)

IsDialogOpen

The editor dialog is a non-blocking modal window, this method returns true if the modal window is open, otherwise false.

Dim result As Boolean = ChromaAnimationAPI.IsDialogOpen()

IsDialogOpenD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsDialogOpenD()

IsInitialized

Returns true if the plugin has been initialized. Returns false if the plugin is uninitialized.

Dim result As Boolean = ChromaAnimationAPI.IsInitialized()

IsInitializedD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsInitializedD()

IsPlatformSupported

If the method can be invoked the method returns true.

Dim result As Boolean = ChromaAnimationAPI.IsPlatformSupported()

IsPlatformSupportedD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsPlatformSupportedD()

IsPlaying

PluginIsPlayingName automatically handles initializing the ChromaSDK. The named .chroma animation file will be automatically opened. The method will return whether the animation is playing or not. Animation is referenced by id.

Dim result As Boolean = ChromaAnimationAPI.IsPlaying(animationId As Integer)

IsPlayingD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsPlayingD(animationId As Double)

IsPlayingName

PluginIsPlayingName automatically handles initializing the ChromaSDK. The named .chroma animation file will be automatically opened. The method will return whether the animation is playing or not. Animation is referenced by name.

Dim result As Boolean = ChromaAnimationAPI.IsPlayingName(path As String)

IsPlayingNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsPlayingNameD(path As String)

IsPlayingType

PluginIsPlayingType automatically handles initializing the ChromaSDK. If any animation is playing for the deviceType and device combination, the method will return true, otherwise false.

Dim result As Boolean = ChromaAnimationAPI.IsPlayingType(deviceType As Integer, device As Integer)

IsPlayingTypeD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.IsPlayingTypeD(deviceType As Double, device As Double)

Lerp

Do a lerp math operation on a float.

Dim result As Single = ChromaAnimationAPI.Lerp(start As Single, renamed_end As Single, amt As Single)

LerpColor

Lerp from one color to another given t in the range 0.0 to 1.0.

Dim result As Integer = ChromaAnimationAPI.LerpColor(from As Integer, renamed_to As Integer, t As Single)

LoadAnimation

Loads Chroma effects so that the animation can be played immediately. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.LoadAnimation(animationId As Integer)

LoadAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.LoadAnimationD(animationId As Double)

LoadAnimationName

Load the named animation.

ChromaAnimationAPI.LoadAnimationName(path As String)

LoadComposite

Load a composite set of animations.

ChromaAnimationAPI.LoadComposite(name As String)

MakeBlankFrames

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color defaults to color. Animation is referenced by id.

ChromaAnimationAPI.MakeBlankFrames(animationId As Integer, frameCount As Integer, duration As Single, color As Integer)

MakeBlankFramesName

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color defaults to color. Animation is referenced by name.

ChromaAnimationAPI.MakeBlankFramesName(path As String, frameCount As Integer, duration As Single, color As Integer)

MakeBlankFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MakeBlankFramesNameD(path As String, frameCount As Double, duration As Double, color As Double)

MakeBlankFramesRandom

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color is random. Animation is referenced by id.

ChromaAnimationAPI.MakeBlankFramesRandom(animationId As Integer, frameCount As Integer, duration As Single)

MakeBlankFramesRandomBlackAndWhite

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color is random black and white. Animation is referenced by id.

ChromaAnimationAPI.MakeBlankFramesRandomBlackAndWhite(animationId As Integer, frameCount As Integer, duration As Single)

MakeBlankFramesRandomBlackAndWhiteName

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color is random black and white. Animation is referenced by name.

ChromaAnimationAPI.MakeBlankFramesRandomBlackAndWhiteName(path As String, frameCount As Integer, duration As Single)

MakeBlankFramesRandomBlackAndWhiteNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MakeBlankFramesRandomBlackAndWhiteNameD(path As String, frameCount As Double, duration As Double)

MakeBlankFramesRandomName

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color is random. Animation is referenced by name.

ChromaAnimationAPI.MakeBlankFramesRandomName(path As String, frameCount As Integer, duration As Single)

MakeBlankFramesRandomNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MakeBlankFramesRandomNameD(path As String, frameCount As Double, duration As Double)

MakeBlankFramesRGB

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color defaults to color. Animation is referenced by id.

ChromaAnimationAPI.MakeBlankFramesRGB(animationId As Integer, frameCount As Integer, duration As Single, red As Integer, green As Integer, blue As Integer)

MakeBlankFramesRGBName

Make a blank animation for the length of the frame count. Frame duration defaults to the duration. The frame color defaults to color. Animation is referenced by name.

ChromaAnimationAPI.MakeBlankFramesRGBName(path As String, frameCount As Integer, duration As Single, red As Integer, green As Integer, blue As Integer)

MakeBlankFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MakeBlankFramesRGBNameD(path As String, frameCount As Double, duration As Double, red As Double, green As Double, blue As Double)

MirrorHorizontally

Flips the color grid horizontally for all Chroma animation frames. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.MirrorHorizontally(animationId As Integer)

MirrorVertically

Flips the color grid vertically for all Chroma animation frames. This method has no effect for EChromaSDKDevice1DEnum devices. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.MirrorVertically(animationId As Integer)

MultiplyColorLerpAllFrames

Multiply the color intensity with the lerp result from color 1 to color 2 using the frame index divided by the frame count for the t parameter. Animation is referenced in id.

ChromaAnimationAPI.MultiplyColorLerpAllFrames(animationId As Integer, color1 As Integer, color2 As Integer)

MultiplyColorLerpAllFramesName

Multiply the color intensity with the lerp result from color 1 to color 2 using the frame index divided by the frame count for the t parameter. Animation is referenced in name.

ChromaAnimationAPI.MultiplyColorLerpAllFramesName(path As String, color1 As Integer, color2 As Integer)

MultiplyColorLerpAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyColorLerpAllFramesNameD(path As String, color1 As Double, color2 As Double)

MultiplyIntensity

Multiply all the colors in the frame by the intensity value. The valid the intensity range is from 0.0 to 255.0. RGB components are multiplied equally. An intensity of 0.5 would half the color value. Black colors in the frame will not be affected by this method.

ChromaAnimationAPI.MultiplyIntensity(animationId As Integer, frameId As Integer, intensity As Single)

MultiplyIntensityAllFrames

Multiply all the colors for all frames by the intensity value. The valid the intensity range is from 0.0 to 255.0. RGB components are multiplied equally. An intensity of 0.5 would half the color value. Black colors in the frame will not be affected by this method.

ChromaAnimationAPI.MultiplyIntensityAllFrames(animationId As Integer, intensity As Single)

MultiplyIntensityAllFramesName

Multiply all the colors for all frames by the intensity value. The valid the intensity range is from 0.0 to 255.0. RGB components are multiplied equally. An intensity of 0.5 would half the color value. Black colors in the frame will not be affected by this method.

ChromaAnimationAPI.MultiplyIntensityAllFramesName(path As String, intensity As Single)

MultiplyIntensityAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyIntensityAllFramesNameD(path As String, intensity As Double)

MultiplyIntensityAllFramesRGB

Multiply all frames by the RBG color intensity. Animation is referenced by id.

ChromaAnimationAPI.MultiplyIntensityAllFramesRGB(animationId As Integer, red As Integer, green As Integer, blue As Integer)

MultiplyIntensityAllFramesRGBName

Multiply all frames by the RBG color intensity. Animation is referenced by name.

ChromaAnimationAPI.MultiplyIntensityAllFramesRGBName(path As String, red As Integer, green As Integer, blue As Integer)

MultiplyIntensityAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyIntensityAllFramesRGBNameD(path As String, red As Double, green As Double, blue As Double)

MultiplyIntensityColor

Multiply the specific frame by the RBG color intensity. Animation is referenced by id.

ChromaAnimationAPI.MultiplyIntensityColor(animationId As Integer, frameId As Integer, color As Integer)

MultiplyIntensityColorAllFrames

Multiply all frames by the RBG color intensity. Animation is referenced by id.

ChromaAnimationAPI.MultiplyIntensityColorAllFrames(animationId As Integer, color As Integer)

MultiplyIntensityColorAllFramesName

Multiply all frames by the RBG color intensity. Animation is referenced by name.

ChromaAnimationAPI.MultiplyIntensityColorAllFramesName(path As String, color As Integer)

MultiplyIntensityColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyIntensityColorAllFramesNameD(path As String, color As Double)

MultiplyIntensityColorName

Multiply the specific frame by the RBG color intensity. Animation is referenced by name.

ChromaAnimationAPI.MultiplyIntensityColorName(path As String, frameId As Integer, color As Integer)

MultiplyIntensityColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyIntensityColorNameD(path As String, frameId As Double, color As Double)

MultiplyIntensityName

Multiply all the colors in the frame by the intensity value. The valid the intensity range is from 0.0 to 255.0. RGB components are multiplied equally. An intensity of 0.5 would half the color value. Black colors in the frame will not be affected by this method.

ChromaAnimationAPI.MultiplyIntensityName(path As String, frameId As Integer, intensity As Single)

MultiplyIntensityNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyIntensityNameD(path As String, frameId As Double, intensity As Double)

MultiplyIntensityRGB

Multiply the specific frame by the RBG color intensity. Animation is referenced by id.

ChromaAnimationAPI.MultiplyIntensityRGB(animationId As Integer, frameId As Integer, red As Integer, green As Integer, blue As Integer)

MultiplyIntensityRGBName

Multiply the specific frame by the RBG color intensity. Animation is referenced by name.

ChromaAnimationAPI.MultiplyIntensityRGBName(path As String, frameId As Integer, red As Integer, green As Integer, blue As Integer)

MultiplyIntensityRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyIntensityRGBNameD(path As String, frameId As Double, red As Double, green As Double, blue As Double)

MultiplyNonZeroTargetColorLerp

Multiply the specific frame by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by id.

ChromaAnimationAPI.MultiplyNonZeroTargetColorLerp(animationId As Integer, frameId As Integer, color1 As Integer, color2 As Integer)

MultiplyNonZeroTargetColorLerpAllFrames

Multiply all frames by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by id.

ChromaAnimationAPI.MultiplyNonZeroTargetColorLerpAllFrames(animationId As Integer, color1 As Integer, color2 As Integer)

MultiplyNonZeroTargetColorLerpAllFramesName

Multiply all frames by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by name.

ChromaAnimationAPI.MultiplyNonZeroTargetColorLerpAllFramesName(path As String, color1 As Integer, color2 As Integer)

MultiplyNonZeroTargetColorLerpAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyNonZeroTargetColorLerpAllFramesNameD(path As String, color1 As Double, color2 As Double)

MultiplyNonZeroTargetColorLerpAllFramesRGB

Multiply the specific frame by the color lerp result between RGB 1 and 2 using the frame color value as the t value. Animation is referenced by id.

ChromaAnimationAPI.MultiplyNonZeroTargetColorLerpAllFramesRGB(animationId As Integer, red1 As Integer, green1 As Integer, blue1 As Integer, red2 As Integer, green2 As Integer, blue2 As Integer)

MultiplyNonZeroTargetColorLerpAllFramesRGBName

Multiply the specific frame by the color lerp result between RGB 1 and 2 using the frame color value as the t value. Animation is referenced by name.

ChromaAnimationAPI.MultiplyNonZeroTargetColorLerpAllFramesRGBName(path As String, red1 As Integer, green1 As Integer, blue1 As Integer, red2 As Integer, green2 As Integer, blue2 As Integer)

MultiplyNonZeroTargetColorLerpAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyNonZeroTargetColorLerpAllFramesRGBNameD(path As String, red1 As Double, green1 As Double, blue1 As Double, red2 As Double, green2 As Double, blue2 As Double)

MultiplyTargetColorLerp

Multiply the specific frame by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by id.

ChromaAnimationAPI.MultiplyTargetColorLerp(animationId As Integer, frameId As Integer, color1 As Integer, color2 As Integer)

MultiplyTargetColorLerpAllFrames

Multiply all frames by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by id.

ChromaAnimationAPI.MultiplyTargetColorLerpAllFrames(animationId As Integer, color1 As Integer, color2 As Integer)

MultiplyTargetColorLerpAllFramesName

Multiply all frames by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by name.

ChromaAnimationAPI.MultiplyTargetColorLerpAllFramesName(path As String, color1 As Integer, color2 As Integer)

MultiplyTargetColorLerpAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyTargetColorLerpAllFramesNameD(path As String, color1 As Double, color2 As Double)

MultiplyTargetColorLerpAllFramesRGB

Multiply all frames by the color lerp result between RGB 1 and 2 using the frame color value as the t value. Animation is referenced by id.

ChromaAnimationAPI.MultiplyTargetColorLerpAllFramesRGB(animationId As Integer, red1 As Integer, green1 As Integer, blue1 As Integer, red2 As Integer, green2 As Integer, blue2 As Integer)

MultiplyTargetColorLerpAllFramesRGBName

Multiply all frames by the color lerp result between RGB 1 and 2 using the frame color value as the t value. Animation is referenced by name.

ChromaAnimationAPI.MultiplyTargetColorLerpAllFramesRGBName(path As String, red1 As Integer, green1 As Integer, blue1 As Integer, red2 As Integer, green2 As Integer, blue2 As Integer)

MultiplyTargetColorLerpAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.MultiplyTargetColorLerpAllFramesRGBNameD(path As String, red1 As Double, green1 As Double, blue1 As Double, red2 As Double, green2 As Double, blue2 As Double)

MultiplyTargetColorLerpName

Multiply the specific frame by the color lerp result between color 1 and 2 using the frame color value as the t value. Animation is referenced by name.

ChromaAnimationAPI.MultiplyTargetColorLerpName(path As String, frameId As Integer, color1 As Integer, color2 As Integer)

OffsetColors

Offset all colors in the frame using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetColors(animationId As Integer, frameId As Integer, red As Integer, green As Integer, blue As Integer)

OffsetColorsAllFrames

Offset all colors for all frames using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetColorsAllFrames(animationId As Integer, red As Integer, green As Integer, blue As Integer)

OffsetColorsAllFramesName

Offset all colors for all frames using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetColorsAllFramesName(path As String, red As Integer, green As Integer, blue As Integer)

OffsetColorsAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OffsetColorsAllFramesNameD(path As String, red As Double, green As Double, blue As Double)

OffsetColorsName

Offset all colors in the frame using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetColorsName(path As String, frameId As Integer, red As Integer, green As Integer, blue As Integer)

OffsetColorsNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OffsetColorsNameD(path As String, frameId As Double, red As Double, green As Double, blue As Double)

OffsetNonZeroColors

This method will only update colors in the animation that are not already set to black. Offset a subset of colors in the frame using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetNonZeroColors(animationId As Integer, frameId As Integer, red As Integer, green As Integer, blue As Integer)

OffsetNonZeroColorsAllFrames

This method will only update colors in the animation that are not already set to black. Offset a subset of colors for all frames using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetNonZeroColorsAllFrames(animationId As Integer, red As Integer, green As Integer, blue As Integer)

OffsetNonZeroColorsAllFramesName

This method will only update colors in the animation that are not already set to black. Offset a subset of colors for all frames using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetNonZeroColorsAllFramesName(path As String, red As Integer, green As Integer, blue As Integer)

OffsetNonZeroColorsAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OffsetNonZeroColorsAllFramesNameD(path As String, red As Double, green As Double, blue As Double)

OffsetNonZeroColorsName

This method will only update colors in the animation that are not already set to black. Offset a subset of colors in the frame using the RGB offset. Use the range of -255 to 255 for red, green, and blue parameters. Negative values remove color. Positive values add color.

ChromaAnimationAPI.OffsetNonZeroColorsName(path As String, frameId As Integer, red As Integer, green As Integer, blue As Integer)

OffsetNonZeroColorsNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OffsetNonZeroColorsNameD(path As String, frameId As Double, red As Double, green As Double, blue As Double)

OpenAnimation

Opens a Chroma animation file so that it can be played. Returns an animation id >= 0 upon success. Returns -1 if there was a failure. The animation id is used in most of the API methods.

Dim result As Integer = ChromaAnimationAPI.OpenAnimation(path As String)

OpenAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OpenAnimationD(path As String)

OpenAnimationFromMemory

Opens a Chroma animation data from memory so that it can be played. Data is a pointer to byte array of the loaded animation in memory. Name will be assigned to the animation when loaded. Returns an animation id >= 0 upon success. Returns -1 if there was a failure. The animation id is used in most of the API methods.

Dim result As Integer = ChromaAnimationAPI.OpenAnimationFromMemory(data As Byte(), name As String)

OpenEditorDialog

Opens a Chroma animation file with the .chroma extension. Returns zero upon success. Returns -1 if there was a failure.

Dim result As Integer = ChromaAnimationAPI.OpenEditorDialog(path As String)

OpenEditorDialogAndPlay

Open the named animation in the editor dialog and play the animation at start.

Dim result As Integer = ChromaAnimationAPI.OpenEditorDialogAndPlay(path As String)

OpenEditorDialogAndPlayD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OpenEditorDialogAndPlayD(path As String)

OpenEditorDialogD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OpenEditorDialogD(path As String)

OverrideFrameDuration

Sets the duration for all grames in the Chroma animation to the duration parameter. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.OverrideFrameDuration(animationId As Integer, duration As Single)

OverrideFrameDurationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.OverrideFrameDurationD(animationId As Double, duration As Double)

OverrideFrameDurationName

Override the duration of all frames with the duration value. Animation is referenced by name.

ChromaAnimationAPI.OverrideFrameDurationName(path As String, duration As Single)

PauseAnimation

Pause the current animation referenced by id.

ChromaAnimationAPI.PauseAnimation(animationId As Integer)

PauseAnimationName

Pause the current animation referenced by name.

ChromaAnimationAPI.PauseAnimationName(path As String)

PauseAnimationNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.PauseAnimationNameD(path As String)

PlayAnimation

Plays the Chroma animation. This will load the animation, if not loaded previously. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.PlayAnimation(animationId As Integer)

PlayAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.PlayAnimationD(animationId As Double)

PlayAnimationFrame

PluginPlayAnimationFrame automatically handles initializing the ChromaSDK. The method will play the animation given the animationId with looping on or off starting at the frameId.

ChromaAnimationAPI.PlayAnimationFrame(animationId As Integer, frameId As Integer, renamed_loop As Boolean)

PlayAnimationFrameName

PluginPlayAnimationFrameName automatically handles initializing the ChromaSDK. The named .chroma animation file will be automatically opened. The animation will play with looping on or off starting at the frameId.

ChromaAnimationAPI.PlayAnimationFrameName(path As String, frameId As Integer, renamed_loop As Boolean)

PlayAnimationFrameNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.PlayAnimationFrameNameD(path As String, frameId As Double, renamed_loop As Double)

PlayAnimationLoop

PluginPlayAnimationLoop automatically handles initializing the ChromaSDK. The method will play the animation given the animationId with looping on or off.

ChromaAnimationAPI.PlayAnimationLoop(animationId As Integer, renamed_loop As Boolean)

PlayAnimationName

PluginPlayAnimationName automatically handles initializing the ChromaSDK. The named .chroma animation file will be automatically opened. The animation will play with looping on or off.

ChromaAnimationAPI.PlayAnimationName(path As String, renamed_loop As Boolean)

PlayAnimationNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.PlayAnimationNameD(path As String, renamed_loop As Double)

PlayComposite

PluginPlayComposite automatically handles initializing the ChromaSDK. The named animation files for the .chroma set will be automatically opened. The set of animations will play with looping on or off.

ChromaAnimationAPI.PlayComposite(name As String, renamed_loop As Boolean)

PlayCompositeD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.PlayCompositeD(name As String, renamed_loop As Double)

PreviewFrame

Displays the Chroma animation frame on Chroma hardware given the frameIndex. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.PreviewFrame(animationId As Integer, frameIndex As Integer)

PreviewFrameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.PreviewFrameD(animationId As Double, frameIndex As Double)

PreviewFrameName

Displays the Chroma animation frame on Chroma hardware given the frameIndex. Animaton is referenced by name.

ChromaAnimationAPI.PreviewFrameName(path As String, frameIndex As Integer)

ReduceFrames

Reduce the frames of the animation by removing every nth element. Animation is referenced by id.

ChromaAnimationAPI.ReduceFrames(animationId As Integer, n As Integer)

ReduceFramesName

Reduce the frames of the animation by removing every nth element. Animation is referenced by name.

ChromaAnimationAPI.ReduceFramesName(path As String, n As Integer)

ReduceFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.ReduceFramesNameD(path As String, n As Double)

ResetAnimation

Resets the Chroma animation to 1 blank frame. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.ResetAnimation(animationId As Integer)

ResumeAnimation

Resume the animation with loop ON or OFF referenced by id.

ChromaAnimationAPI.ResumeAnimation(animationId As Integer, renamed_loop As Boolean)

ResumeAnimationName

Resume the animation with loop ON or OFF referenced by name.

ChromaAnimationAPI.ResumeAnimationName(path As String, renamed_loop As Boolean)

ResumeAnimationNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.ResumeAnimationNameD(path As String, renamed_loop As Double)

Reverse

Reverse the animation frame order of the Chroma animation. Returns the animation id upon success. Returns -1 upon failure. Animation is referenced by id.

Dim result As Integer = ChromaAnimationAPI.Reverse(animationId As Integer)

ReverseAllFrames

Reverse the animation frame order of the Chroma animation. Animation is referenced by id.

ChromaAnimationAPI.ReverseAllFrames(animationId As Integer)

ReverseAllFramesName

Reverse the animation frame order of the Chroma animation. Animation is referenced by name.

ChromaAnimationAPI.ReverseAllFramesName(path As String)

ReverseAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.ReverseAllFramesNameD(path As String)

SaveAnimation

Save the animation referenced by id to the path specified.

Dim result As Integer = ChromaAnimationAPI.SaveAnimation(animationId As Integer, path As String)

SaveAnimationName

Save the named animation to the target path specified.

Dim result As Integer = ChromaAnimationAPI.SaveAnimationName(sourceAnimation As String, targetAnimation As String)

Set1DColor

Set the animation color for a frame given the 1D led. The led should be greater than or equal to 0 and less than the MaxLeds. The animation is referenced by id.

ChromaAnimationAPI.Set1DColor(animationId As Integer, frameId As Integer, led As Integer, color As Integer)

Set1DColorName

Set the animation color for a frame given the 1D led. The led should be greater than or equal to 0 and less than the MaxLeds. The animation is referenced by name.

ChromaAnimationAPI.Set1DColorName(path As String, frameId As Integer, led As Integer, color As Integer)

Set1DColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.Set1DColorNameD(path As String, frameId As Double, led As Double, color As Double)

Set2DColor

Set the animation color for a frame given the 2D row and column. The row should be greater than or equal to 0 and less than the MaxRow. The column should be greater than or equal to 0 and less than the MaxColumn. The animation is referenced by id.

ChromaAnimationAPI.Set2DColor(animationId As Integer, frameId As Integer, row As Integer, column As Integer, color As Integer)

Set2DColorName

Set the animation color for a frame given the 2D row and column. The row should be greater than or equal to 0 and less than the MaxRow. The column should be greater than or equal to 0 and less than the MaxColumn. The animation is referenced by name.

ChromaAnimationAPI.Set2DColorName(path As String, frameId As Integer, row As Integer, column As Integer, color As Integer)

Set2DColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.Set2DColorNameD(path As String, frameId As Double, rowColumnIndex As Double, color As Double)

SetChromaCustomColorAllFrames

When custom color is set, the custom key mode will be used. The animation is referenced by id.

ChromaAnimationAPI.SetChromaCustomColorAllFrames(animationId As Integer)

SetChromaCustomColorAllFramesName

When custom color is set, the custom key mode will be used. The animation is referenced by name.

ChromaAnimationAPI.SetChromaCustomColorAllFramesName(path As String)

SetChromaCustomColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetChromaCustomColorAllFramesNameD(path As String)

SetChromaCustomFlag

Set the Chroma custom key color flag on all frames. True changes the layout from grid to key. True changes the layout from key to grid. Animation is referenced by id.

ChromaAnimationAPI.SetChromaCustomFlag(animationId As Integer, flag As Boolean)

SetChromaCustomFlagName

Set the Chroma custom key color flag on all frames. True changes the layout from grid to key. True changes the layout from key to grid. Animation is referenced by name.

ChromaAnimationAPI.SetChromaCustomFlagName(path As String, flag As Boolean)

SetChromaCustomFlagNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetChromaCustomFlagNameD(path As String, flag As Double)

SetCurrentFrame

Set the current frame of the animation referenced by id.

ChromaAnimationAPI.SetCurrentFrame(animationId As Integer, frameId As Integer)

SetCurrentFrameName

Set the current frame of the animation referenced by name.

ChromaAnimationAPI.SetCurrentFrameName(path As String, frameId As Integer)

SetCurrentFrameNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetCurrentFrameNameD(path As String, frameId As Double)

SetCustomColorFlag2D

Set the custom alpha flag on the color array

Dim result As Integer = ChromaAnimationAPI.SetCustomColorFlag2D(device As Integer, colors As Integer())

SetDevice

Changes the deviceType and device of a Chroma animation. If the device is changed, the Chroma animation will be reset with 1 blank frame. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.SetDevice(animationId As Integer, deviceType As Integer, device As Integer)

SetEffect

SetEffect will display the referenced effect id.

Dim result As Integer = ChromaAnimationAPI.SetEffect(effectId As Guid)

SetEffectCustom1D

SetEffectCustom1D will display the referenced colors immediately

Dim result As Integer = ChromaAnimationAPI.SetEffectCustom1D(device As Integer, colors As Integer())

SetEffectCustom2D

SetEffectCustom2D will display the referenced colors immediately

Dim result As Integer = ChromaAnimationAPI.SetEffectCustom2D(device As Integer, colors As Integer())

SetEffectKeyboardCustom2D

SetEffectKeyboardCustom2D will display the referenced custom keyboard colors immediately

Dim result As Integer = ChromaAnimationAPI.SetEffectKeyboardCustom2D(device As Integer, colors As Integer())

SetIdleAnimation

When the idle animation is used, the named animation will play when no other animations are playing. Reference the animation by id.

ChromaAnimationAPI.SetIdleAnimation(animationId As Integer)

SetIdleAnimationName

When the idle animation is used, the named animation will play when no other animations are playing. Reference the animation by name.

ChromaAnimationAPI.SetIdleAnimationName(path As String)

SetKeyColor

Set animation key to a static color for the given frame.

ChromaAnimationAPI.SetKeyColor(animationId As Integer, frameId As Integer, rzkey As Integer, color As Integer)

SetKeyColorAllFrames

Set the key to the specified key color for all frames. Animation is referenced by id.

ChromaAnimationAPI.SetKeyColorAllFrames(animationId As Integer, rzkey As Integer, color As Integer)

SetKeyColorAllFramesName

Set the key to the specified key color for all frames. Animation is referenced by name.

ChromaAnimationAPI.SetKeyColorAllFramesName(path As String, rzkey As Integer, color As Integer)

SetKeyColorAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyColorAllFramesNameD(path As String, rzkey As Double, color As Double)

SetKeyColorAllFramesRGB

Set the key to the specified key color for all frames. Animation is referenced by id.

ChromaAnimationAPI.SetKeyColorAllFramesRGB(animationId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyColorAllFramesRGBName

Set the key to the specified key color for all frames. Animation is referenced by name.

ChromaAnimationAPI.SetKeyColorAllFramesRGBName(path As String, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyColorAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyColorAllFramesRGBNameD(path As String, rzkey As Double, red As Double, green As Double, blue As Double)

SetKeyColorName

Set animation key to a static color for the given frame.

ChromaAnimationAPI.SetKeyColorName(path As String, frameId As Integer, rzkey As Integer, color As Integer)

SetKeyColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyColorNameD(path As String, frameId As Double, rzkey As Double, color As Double)

SetKeyColorRGB

Set the key to the specified key color for the specified frame. Animation is referenced by id.

ChromaAnimationAPI.SetKeyColorRGB(animationId As Integer, frameId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyColorRGBName

Set the key to the specified key color for the specified frame. Animation is referenced by name.

ChromaAnimationAPI.SetKeyColorRGBName(path As String, frameId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyColorRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyColorRGBNameD(path As String, frameId As Double, rzkey As Double, red As Double, green As Double, blue As Double)

SetKeyNonZeroColor

Set animation key to a static color for the given frame if the existing color is not already black.

ChromaAnimationAPI.SetKeyNonZeroColor(animationId As Integer, frameId As Integer, rzkey As Integer, color As Integer)

SetKeyNonZeroColorName

Set animation key to a static color for the given frame if the existing color is not already black.

ChromaAnimationAPI.SetKeyNonZeroColorName(path As String, frameId As Integer, rzkey As Integer, color As Integer)

SetKeyNonZeroColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyNonZeroColorNameD(path As String, frameId As Double, rzkey As Double, color As Double)

SetKeyNonZeroColorRGB

Set the key to the specified key color for the specified frame where color is not black. Animation is referenced by id.

ChromaAnimationAPI.SetKeyNonZeroColorRGB(animationId As Integer, frameId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyNonZeroColorRGBName

Set the key to the specified key color for the specified frame where color is not black. Animation is referenced by name.

ChromaAnimationAPI.SetKeyNonZeroColorRGBName(path As String, frameId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyNonZeroColorRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyNonZeroColorRGBNameD(path As String, frameId As Double, rzkey As Double, red As Double, green As Double, blue As Double)

SetKeyRowColumnColorName

Set animation key by row and column to a static color for the given frame.

ChromaAnimationAPI.SetKeyRowColumnColorName(path As String, frameId As Integer, row As Integer, column As Integer, color As Integer)

SetKeysColor

Set an array of animation keys to a static color for the given frame. Animation is referenced by id.

ChromaAnimationAPI.SetKeysColor(animationId As Integer, frameId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysColorAllFrames

Set an array of animation keys to a static color for all frames. Animation is referenced by id.

ChromaAnimationAPI.SetKeysColorAllFrames(animationId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysColorAllFramesName

Set an array of animation keys to a static color for all frames. Animation is referenced by name.

ChromaAnimationAPI.SetKeysColorAllFramesName(path As String, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysColorAllFramesRGB

Set an array of animation keys to a static color for all frames. Animation is referenced by id.

ChromaAnimationAPI.SetKeysColorAllFramesRGB(animationId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysColorAllFramesRGBName

Set an array of animation keys to a static color for all frames. Animation is referenced by name.

ChromaAnimationAPI.SetKeysColorAllFramesRGBName(path As String, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysColorName

Set an array of animation keys to a static color for the given frame.

ChromaAnimationAPI.SetKeysColorName(path As String, frameId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysColorRGB

Set an array of animation keys to a static color for the given frame. Animation is referenced by id.

ChromaAnimationAPI.SetKeysColorRGB(animationId As Integer, frameId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysColorRGBName

Set an array of animation keys to a static color for the given frame. Animation is referenced by name.

ChromaAnimationAPI.SetKeysColorRGBName(path As String, frameId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysNonZeroColor

Set an array of animation keys to a static color for the given frame if the existing color is not already black.

ChromaAnimationAPI.SetKeysNonZeroColor(animationId As Integer, frameId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysNonZeroColorAllFrames

Set an array of animation keys to a static color for the given frame where the color is not black. Animation is referenced by id.

ChromaAnimationAPI.SetKeysNonZeroColorAllFrames(animationId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysNonZeroColorAllFramesName

Set an array of animation keys to a static color for all frames if the existing color is not already black. Reference animation by name.

ChromaAnimationAPI.SetKeysNonZeroColorAllFramesName(path As String, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysNonZeroColorName

Set an array of animation keys to a static color for the given frame if the existing color is not already black. Reference animation by name.

ChromaAnimationAPI.SetKeysNonZeroColorName(path As String, frameId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysNonZeroColorRGB

Set an array of animation keys to a static color for the given frame where the color is not black. Animation is referenced by id.

ChromaAnimationAPI.SetKeysNonZeroColorRGB(animationId As Integer, frameId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysNonZeroColorRGBName

Set an array of animation keys to a static color for the given frame where the color is not black. Animation is referenced by name.

ChromaAnimationAPI.SetKeysNonZeroColorRGBName(path As String, frameId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysZeroColor

Set an array of animation keys to a static color for the given frame where the color is black. Animation is referenced by id.

ChromaAnimationAPI.SetKeysZeroColor(animationId As Integer, frameId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysZeroColorAllFrames

Set an array of animation keys to a static color for all frames where the color is black. Animation is referenced by id.

ChromaAnimationAPI.SetKeysZeroColorAllFrames(animationId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysZeroColorAllFramesName

Set an array of animation keys to a static color for all frames where the color is black. Animation is referenced by name.

ChromaAnimationAPI.SetKeysZeroColorAllFramesName(path As String, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysZeroColorAllFramesRGB

Set an array of animation keys to a static color for all frames where the color is black. Animation is referenced by id.

ChromaAnimationAPI.SetKeysZeroColorAllFramesRGB(animationId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysZeroColorAllFramesRGBName

Set an array of animation keys to a static color for all frames where the color is black. Animation is referenced by name.

ChromaAnimationAPI.SetKeysZeroColorAllFramesRGBName(path As String, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysZeroColorName

Set an array of animation keys to a static color for the given frame where the color is black. Animation is referenced by name.

ChromaAnimationAPI.SetKeysZeroColorName(path As String, frameId As Integer, rzkeys As Integer(), keyCount As Integer, color As Integer)

SetKeysZeroColorRGB

Set an array of animation keys to a static color for the given frame where the color is black. Animation is referenced by id.

ChromaAnimationAPI.SetKeysZeroColorRGB(animationId As Integer, frameId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeysZeroColorRGBName

Set an array of animation keys to a static color for the given frame where the color is black. Animation is referenced by name.

ChromaAnimationAPI.SetKeysZeroColorRGBName(path As String, frameId As Integer, rzkeys As Integer(), keyCount As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyZeroColor

Set animation key to a static color for the given frame where the color is black. Animation is referenced by id.

ChromaAnimationAPI.SetKeyZeroColor(animationId As Integer, frameId As Integer, rzkey As Integer, color As Integer)

SetKeyZeroColorName

Set animation key to a static color for the given frame where the color is black. Animation is referenced by name.

ChromaAnimationAPI.SetKeyZeroColorName(path As String, frameId As Integer, rzkey As Integer, color As Integer)

SetKeyZeroColorNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyZeroColorNameD(path As String, frameId As Double, rzkey As Double, color As Double)

SetKeyZeroColorRGB

Set animation key to a static color for the given frame where the color is black. Animation is referenced by id.

ChromaAnimationAPI.SetKeyZeroColorRGB(animationId As Integer, frameId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyZeroColorRGBName

Set animation key to a static color for the given frame where the color is black. Animation is referenced by name.

ChromaAnimationAPI.SetKeyZeroColorRGBName(path As String, frameId As Integer, rzkey As Integer, red As Integer, green As Integer, blue As Integer)

SetKeyZeroColorRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SetKeyZeroColorRGBNameD(path As String, frameId As Double, rzkey As Double, red As Double, green As Double, blue As Double)

SetLogDelegate

Invokes the setup for a debug logging callback so that stdout is redirected to the callback. This is used by Unity so that debug messages can appear in the console window.

ChromaAnimationAPI.SetLogDelegate(fp As IntPtr)

SetStaticColor

Sets the target device to the static color.

ChromaAnimationAPI.SetStaticColor(deviceType As Integer, device As Integer, color As Integer)

SetStaticColorAll

Sets all devices to the static color.

ChromaAnimationAPI.SetStaticColorAll(color As Integer)

StaticColor

Sets the target device to the static color.

ChromaAnimationAPI.StaticColor(deviceType As Integer, device As Integer, color As Integer)

StaticColorAll

Sets all devices to the static color.

ChromaAnimationAPI.StaticColorAll(color As Integer)

StaticColorD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.StaticColorD(deviceType As Double, device As Double, color As Double)

StopAll

PluginStopAll will automatically stop all animations that are playing.

ChromaAnimationAPI.StopAll()

StopAnimation

Stops animation playback if in progress. Returns the animation id upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.StopAnimation(animationId As Integer)

StopAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.StopAnimationD(animationId As Double)

StopAnimationName

PluginStopAnimationName automatically handles initializing the ChromaSDK. The named .chroma animation file will be automatically opened. The animation will stop if playing.

ChromaAnimationAPI.StopAnimationName(path As String)

StopAnimationNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.StopAnimationNameD(path As String)

StopAnimationType

PluginStopAnimationType automatically handles initializing the ChromaSDK. If any animation is playing for the deviceType and device combination, it will be stopped.

ChromaAnimationAPI.StopAnimationType(deviceType As Integer, device As Integer)

StopAnimationTypeD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.StopAnimationTypeD(deviceType As Double, device As Double)

StopComposite

PluginStopComposite automatically handles initializing the ChromaSDK. The named animation files for the .chroma set will be automatically opened. The set of animations will be stopped if playing.

ChromaAnimationAPI.StopComposite(name As String)

StopCompositeD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.StopCompositeD(name As String)

SubtractColor

Return color1 - color2

Dim result As Integer = ChromaAnimationAPI.SubtractColor(color1 As Integer, color2 As Integer)

SubtractNonZeroAllKeysAllFrames

Subtract the source color from the target color for all frames where the target color is not black. Source and target are referenced by id.

ChromaAnimationAPI.SubtractNonZeroAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

SubtractNonZeroAllKeysAllFramesName

Subtract the source color from the target color for all frames where the target color is not black. Source and target are referenced by name.

ChromaAnimationAPI.SubtractNonZeroAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

SubtractNonZeroAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractNonZeroAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

SubtractNonZeroAllKeysAllFramesOffset

Subtract the source color from the target color for all frames where the target color is not black starting at offset for the length of the source. Source and target are referenced by id.

ChromaAnimationAPI.SubtractNonZeroAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

SubtractNonZeroAllKeysAllFramesOffsetName

Subtract the source color from the target color for all frames where the target color is not black starting at offset for the length of the source. Source and target are referenced by name.

ChromaAnimationAPI.SubtractNonZeroAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

SubtractNonZeroAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractNonZeroAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

SubtractNonZeroAllKeysOffset

Subtract the source color from the target where color is not black for the source frame and target offset frame, reference source and target by id.

ChromaAnimationAPI.SubtractNonZeroAllKeysOffset(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, offset As Integer)

SubtractNonZeroAllKeysOffsetName

Subtract the source color from the target where color is not black for the source frame and target offset frame, reference source and target by name.

ChromaAnimationAPI.SubtractNonZeroAllKeysOffsetName(sourceAnimation As String, targetAnimation As String, frameId As Integer, offset As Integer)

SubtractNonZeroAllKeysOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractNonZeroAllKeysOffsetNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, offset As Double)

SubtractNonZeroTargetAllKeysAllFrames

Subtract the source color from the target color where the target color is not black for all frames. Reference source and target by id.

ChromaAnimationAPI.SubtractNonZeroTargetAllKeysAllFrames(sourceAnimationId As Integer, targetAnimationId As Integer)

SubtractNonZeroTargetAllKeysAllFramesName

Subtract the source color from the target color where the target color is not black for all frames. Reference source and target by name.

ChromaAnimationAPI.SubtractNonZeroTargetAllKeysAllFramesName(sourceAnimation As String, targetAnimation As String)

SubtractNonZeroTargetAllKeysAllFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractNonZeroTargetAllKeysAllFramesNameD(sourceAnimation As String, targetAnimation As String)

SubtractNonZeroTargetAllKeysAllFramesOffset

Subtract the source color from the target color where the target color is not black for all frames starting at the target offset for the length of the source. Reference source and target by id.

ChromaAnimationAPI.SubtractNonZeroTargetAllKeysAllFramesOffset(sourceAnimationId As Integer, targetAnimationId As Integer, offset As Integer)

SubtractNonZeroTargetAllKeysAllFramesOffsetName

Subtract the source color from the target color where the target color is not black for all frames starting at the target offset for the length of the source. Reference source and target by name.

ChromaAnimationAPI.SubtractNonZeroTargetAllKeysAllFramesOffsetName(sourceAnimation As String, targetAnimation As String, offset As Integer)

SubtractNonZeroTargetAllKeysAllFramesOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractNonZeroTargetAllKeysAllFramesOffsetNameD(sourceAnimation As String, targetAnimation As String, offset As Double)

SubtractNonZeroTargetAllKeysOffset

Subtract the source color from the target color where the target color is not black from the source frame to the target offset frame. Reference source and target by id.

ChromaAnimationAPI.SubtractNonZeroTargetAllKeysOffset(sourceAnimationId As Integer, targetAnimationId As Integer, frameId As Integer, offset As Integer)

SubtractNonZeroTargetAllKeysOffsetName

Subtract the source color from the target color where the target color is not black from the source frame to the target offset frame. Reference source and target by name.

ChromaAnimationAPI.SubtractNonZeroTargetAllKeysOffsetName(sourceAnimation As String, targetAnimation As String, frameId As Integer, offset As Integer)

SubtractNonZeroTargetAllKeysOffsetNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractNonZeroTargetAllKeysOffsetNameD(sourceAnimation As String, targetAnimation As String, frameId As Double, offset As Double)

SubtractThresholdColorsMinMaxAllFramesRGB

Subtract all frames with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by id.

ChromaAnimationAPI.SubtractThresholdColorsMinMaxAllFramesRGB(animationId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

SubtractThresholdColorsMinMaxAllFramesRGBName

Subtract all frames with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by name.

ChromaAnimationAPI.SubtractThresholdColorsMinMaxAllFramesRGBName(path As String, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

SubtractThresholdColorsMinMaxAllFramesRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractThresholdColorsMinMaxAllFramesRGBNameD(path As String, minThreshold As Double, minRed As Double, minGreen As Double, minBlue As Double, maxThreshold As Double, maxRed As Double, maxGreen As Double, maxBlue As Double)

SubtractThresholdColorsMinMaxRGB

Subtract the specified frame with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by id.

ChromaAnimationAPI.SubtractThresholdColorsMinMaxRGB(animationId As Integer, frameId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

SubtractThresholdColorsMinMaxRGBName

Subtract the specified frame with the min RGB color where the animation color is less than the min threshold AND with the max RGB color where the animation is more than the max threshold. Animation is referenced by name.

ChromaAnimationAPI.SubtractThresholdColorsMinMaxRGBName(path As String, frameId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

SubtractThresholdColorsMinMaxRGBNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.SubtractThresholdColorsMinMaxRGBNameD(path As String, frameId As Integer, minThreshold As Integer, minRed As Integer, minGreen As Integer, minBlue As Integer, maxThreshold As Integer, maxRed As Integer, maxGreen As Integer, maxBlue As Integer)

TrimEndFrames

Trim the end of the animation. The length of the animation will be the lastFrameId

    1. Reference the animation by id.
ChromaAnimationAPI.TrimEndFrames(animationId As Integer, lastFrameId As Integer)

TrimEndFramesName

Trim the end of the animation. The length of the animation will be the lastFrameId

    1. Reference the animation by name.
ChromaAnimationAPI.TrimEndFramesName(path As String, lastFrameId As Integer)

TrimEndFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.TrimEndFramesNameD(path As String, lastFrameId As Double)

TrimFrame

Remove the frame from the animation. Reference animation by id.

ChromaAnimationAPI.TrimFrame(animationId As Integer, frameId As Integer)

TrimFrameName

Remove the frame from the animation. Reference animation by name.

ChromaAnimationAPI.TrimFrameName(path As String, frameId As Integer)

TrimFrameNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.TrimFrameNameD(path As String, frameId As Double)

TrimStartFrames

Trim the start of the animation starting at frame 0 for the number of frames. Reference the animation by id.

ChromaAnimationAPI.TrimStartFrames(animationId As Integer, numberOfFrames As Integer)

TrimStartFramesName

Trim the start of the animation starting at frame 0 for the number of frames. Reference the animation by name.

ChromaAnimationAPI.TrimStartFramesName(path As String, numberOfFrames As Integer)

TrimStartFramesNameD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.TrimStartFramesNameD(path As String, numberOfFrames As Double)

Uninit

Uninitializes the ChromaSDK. Returns 0 upon success. Returns -1 upon failure.

Dim result As Integer = ChromaAnimationAPI.Uninit()

UninitD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.UninitD()

UnloadAnimation

Unloads Chroma effects to free up resources. Returns the animation id upon success. Returns -1 upon failure. Reference the animation by id.

Dim result As Integer = ChromaAnimationAPI.UnloadAnimation(animationId As Integer)

UnloadAnimationD

D suffix for limited data types.

Dim result As Double = ChromaAnimationAPI.UnloadAnimationD(animationId As Double)

UnloadAnimationName

Unload the animation effects. Reference the animation by name.

ChromaAnimationAPI.UnloadAnimationName(path As String)

UnloadComposite

Unload the the composite set of animation effects. Reference the animation by name.

ChromaAnimationAPI.UnloadComposite(name As String)

UnloadLibrarySDK

Unload the Razer Chroma SDK Library before exiting the application.

ChromaAnimationAPI.UnloadLibrarySDK()

UnloadLibraryStreamingPlugin

Unload the Razer Chroma Streaming Plugin Library before exiting the application.

ChromaAnimationAPI.UnloadLibraryStreamingPlugin()

UpdateFrame

Updates the frameIndex of the Chroma animation and sets the duration (in seconds). The color is expected to be an array of the dimensions for the deviceType/device. The length parameter is the size of the color array. For EChromaSDKDevice1DEnum the array size should be MAX LEDS. For EChromaSDKDevice2DEnum the array size should be MAX ROW

  • MAX COLUMN. Returns the animation id upon success. Returns -1 upon failure.
Dim result As Integer = ChromaAnimationAPI.UpdateFrame(animationId As Integer, frameIndex As Integer, duration As Single, colors As Integer(), length As Integer)

UpdateFrameName

Updates the frameIndex of the Chroma animation and sets the duration (in seconds). The color is expected to be an array of the dimensions for the deviceType/device. The length parameter is the size of the color array. For EChromaSDKDevice1DEnum the array size should be MAX LEDS. For EChromaSDKDevice2DEnum the array size should be MAX ROW

  • MAX COLUMN. Returns the animation id upon success. Returns -1 upon failure.
Dim result As Integer = ChromaAnimationAPI.UpdateFrameName(path As String, frameIndex As Integer, duration As Single, colors As Integer(), length As Integer)

UseIdleAnimation

When the idle animation flag is true, when no other animations are playing, the idle animation will be used. The idle animation will not be affected by the API calls to PluginIsPlaying, PluginStopAnimationType, PluginGetPlayingAnimationId, and PluginGetPlayingAnimationCount. Then the idle animation flag is false, the idle animation is disabled. Device uses EChromaSDKDeviceEnum enums.

ChromaAnimationAPI.UseIdleAnimation(device As Integer, flag As Boolean)

UseIdleAnimations

Set idle animation flag for all devices.

ChromaAnimationAPI.UseIdleAnimations(flag As Boolean)

UsePreloading

Set preloading animation flag, which is set to true by default. Reference animation by id.

ChromaAnimationAPI.UsePreloading(animationId As Integer, flag As Boolean)

UsePreloadingName

Set preloading animation flag, which is set to true by default. Reference animation by name.

ChromaAnimationAPI.UsePreloadingName(path As String, flag As Boolean)

About

VB Chroma sample that dynamically sets colors in a game loop

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages