Avatar SDK Unity plugin (Offline version)  2.0.0
Realistic avatar generation toolset for Unity3D
Scene #05: Parameters Sample

This scene demonstrates API that allows working with computation parameters and flags. These parameters and flags configure which auxiliary features and resources should be generated for the avatar.

The SDK will tell you which resources and parameters are available for your account (this is the full list that you see in the UI). Then before the avatar is generated you can specify which resources you need and which parameters you would like to apply.

Currently, the following groups with parameters are available:

  • Haircuts
  • Blendshapes
  • Model Info
  • Avatar Modifications


Unity plugin includes the following sets of artificial haircuts:

  • Base set: 3 male and 3 female haircuts
  • Plus set: set of haircuts available for HEAD 2.0 and BUST 2.0
  • Generated: haircut generated from original image (available for HEAD 2.0 and BUST 2.0)

It is possible to add custom haircuts to your account. Please contact us at suppo.nosp@m.rt@a.nosp@m.vatar.nosp@m.sdk..nosp@m.com to implement this, we will provide the implementation details on a custom basis. Once the custom haircuts are added, the SDK will return more haircuts in the available haircuts list.


Avatar SDK supports animated avatars using blendshapes. HEAD 2.0 and BUST 2.0 support one set of blendshapes:

Model Info

This group of flags configures which meta-information should be generated for the avatar.

  • Hair Color: Compute average haircut color from submitted photo.
  • Skin Color: Compute average skin color from submitted photo.
  • Gender: Predict person's gender from submitted photo (male or female) and confidence.
  • Age: Classify to which age group the person from the photo belongs to. There are two groups: Child and Adult.
  • Eye Sclera Color: Compute average eye sclera color from submitted photo.
  • Eye Iris Color: Compute average eye iris color from submitted photo.

Avatar Modifications

Group of parameters that allows to modify the avatar:

  • Add Eyelid Shadow: Add an eyelid shadow on the regular texture.
  • Add Glare: Add a glare to the eyes on the regular texture.
  • Curved Bottom: Make the bottom of the HEAD 2.0 model slightly curved. Applied only to the "bust/mobile" avatars. See models comparison below.
  • Eye Iris Color: Allow to set the iris color.
  • Eye Sclera Color: Allow to set the eye sclera color.
  • Hair color: Recolor generated haircut directly on a haircut texture.
  • Parametric eyes texture: Replace eye texture from submitted photo to generated one with sclera and iris colors match the photo version.
  • Allow Modify Neck: By default this flag is set to True and the neck is modified to better match submitted photo. Disable it if you need the fixed neck size for all models for easier attaching to the body. Applicable only for the "head/mobile" subtype.

Parameters availability:

Parameter Name "head/mobile" subtype "bust/mobile" subtype
Add Eyelid Shadow + +
Add Glare + +
Curved Bottom - +
Eye Iris Color + +
Eye Sclera Color + +
Hair Color + +
Parametric eyes texture + +
Allow Modify Neck + -

See also FAQ and the getting started instructions on the main page: Main Page.