Document

• 1: Getting Started
• 1.1: Setup Guide
• 1.2: Shooting Guide
• 1.3: Upgrade Guide
• 2: Feature List
• 2.1: Basic Features: Zoom, Aperture, Exposure
• 2.2: Focus Control
• 2.3: Position and Orientation Control
• 2.4: Other Features
• 3: Configuration Reference
• 3.1: List of Configuration Parameters
• 3.2: Replacing the Camera Model
• 3.3: 4K Capturing
• 3.4: Creating Setting Templates
• 4: Developer Guide
• 5: Frequently Asked Questions
• 6: Changelog
• 7: Readme

1 - Getting Started

1.1 - Setup Guide

Requirement Check

Before setting up VirtualLens2, please ensure that the target avatar meets the following requirements:

• It is set up using VRCSDK 3.1.12 or later.
• Modular Avatar 1.8.0 or later is imported into the project.
• Expression Parameters have a margin of at least 8 bits.

Import Modular Avatar

Refer to the Modular Avatar documentation and import Modular Avatar into your project. If it’s already imported, make sure the version is 1.8.0 or later.

Import Unitypackage File

Import the downloaded package (VirtualLens2_v2.x.x.unitypackage) into your project.

Running Setup Helper

Select the avatar you want to set up, right-click, and choose “VirtualLens2” → “Non-Destructive Setup”. The setup helper will launch, so review the following settings and then press the “Apply” button.

Placing the Camera Model

If the automatic placement of a camera model other than the default doesn’t work, you need to place the model manually. After adding the model to the scene, adjust its position and orientation. Move it to be a child of the bone you want the camera to follow. Additionally, you’ll need to enter information about the model into the VirtualLens Settings component. Refer to the image below and set the information below “Camera Object.”

Uploading the Avatar

Now the setup of VirtualLens2 is complete. Upload your avatar and try using it.

1.2 - Shooting Guide

Basic Usage

Preparing the Built-in Camera

From the menu, go to “Camera” → “Photo Camera” (or “Stream Camera” for video recording) and take out the built-in VRChat camera. If the focus feature is enabled, disable it beforehand to prevent interference.

Launching VirtualLens

1. VirtualLens2
2. Enable

Open the action menu and go to “Expressions” → “VirtualLens2” → “Enable” to launch VirtualLens2. While it’s active, the image seen in the built-in camera will be overridden with the one captured by VirtualLens. In this state, you can take and save photos captured by VirtualLens by triggering the shutter on the standard camera.

1.3 - Upgrade Guide

Basic Steps

Importing the Unitypackage File

Import the Unitypackage file of the latest version that you downloaded (VirtualLens2_v2.x.x.unitypackage) to overwrite.

Reapplying Settings (For Destructive Setup Only)

Press the “Apply” button in the VirtualLens Settings component that was generated during the initial setup to update the data within your avatar.

Version-Specific Steps

Updates from v2.9.9 or Earlier

Starting from VirtualLens2 v2.10.0, it is recommended to use the non-destructive setup. If you set up VirtualLens2 with a version earlier than v2.9.9, you can migrate to the non-destructive setup by importing Modular Avatar (version 1.8.0 or later) into your project and pressing the “Migrate as a Non-destructive Module” button in the VirtualLens Settings component.

Once you have migrated to the non-destructive setup, you won’t need to reapply settings for future updates.

Updates from v2.8.5 or Earlier

Starting from VirtualLens2 v2.9.0, default settings are provided through a prefab (VirtualLens2/Prefabs/DefaultSettings.prefab). The settings objects generated automatically by the setup helper in versions earlier than v2.8.5 are not instances of this prefab. To ensure that parameter adjustments in future updates are correctly reflected, it is recommended to replace the current settings objects with instances of the prefab.

To replace the settings objects, press the “Replace by Prefab Instance” button at the bottom of the VirtualLens Settings component to generate instances of the prefab with the current values, as needed.

2 - Feature List

2.1 - Basic Features: Zoom, Aperture, Exposure

Zoom

1. VirtualLens2
2. Zoom

Zoom controls the lens’s focal length (angle of view or magnification). The focal length can be adjusted within the range specified during setup, from “Min Focal Length” to “Max Focal Length.”

Aperture

1. VirtualLens2
2. Aperture

Aperture controls the lens’s aperture size (F-number, depth of field). The F-number can be adjusted within the range specified during setup, from “Min F Number” to “Max F Number.” When the value is 0%, the blur effect from depth of field simulation is disabled.

Exposure

1. VirtualLens2
2. Image Control
3. Exposure

Exposure controls the brightness of the image. The exposure value can be adjusted within the range specified during setup, within the “Exposure Range.” When the value is set at 50%, there is no exposure compensation (0EV).

2.2 - Focus Control

Autofocus Modes

VirtualLens2 provides three autofocus modes:

Point AF

1. VirtualLens2
2. Image Control
3. Focus Control
4. AF Mode
5. Point AF

In this mode, the focus adjusts to the point on the preview screen where the cursor is located. You can move this cursor by touching the preview screen with the index finger of the hand without the camera.

Face AF

1. VirtualLens2
2. Image Control
3. Focus Control
4. AF Mode
5. Face AF

Face AF detects and focuses on the avatar’s face or eyes in the current image. If there are multiple faces in the frame, you can select which face to focus on by touching the preview screen with your index finger.

Selfie AF

1. VirtualLens2
2. Image Control
3. Focus Control
4. AF Mode
5. Selfie AF

Selfie AF focuses on the eyes of the person taking the photo. It is a lightweight and stable option compared to Face AF, making it ideal for use when there is no need to focus on other players.

Autofocus Parameters

Face Detection Switching Speed

1. VirtualLens2
2. Image Control
3. Focus Control
4. Tracking Speed

When using Face AF, if the detection of the tracked face fails, the system will attempt to switch focus to a nearby face from the last detected point. This parameter controls the speed at which the system expands the search range to find a new tracking target.

Increasing the speed reduces the time during which there is no focus on any subject in situations with frequent changes in subjects. However, it may lead to unintentional changes in focus to different individuals if the face detection is unstable. Conversely, decreasing the speed ensures stable focus even with unstable face detection, but it takes more time for the system to switch to a new subject automatically.

Focus Adjustment Speed

1. VirtualLens2
2. Image Control
3. Focus Control
4. Focusing Speed

This parameter adjusts the speed at which the point where the autofocus sets the focus moves. Slowing down this speed results in a gradual change in distance to the focus plane over time.

Manual Focus

1. VirtualLens2
2. Image Control
3. Manual Focusing

For manual focus, set the distance to the focal plane. The adjustable range can be configured during setup, within the “Min Focus Distance” to “Max Focus Distance” range. When this parameter is set to 0%, autofocus is used.

2.3 - Position and Orientation Control

Auto Horizon Leveling

1. VirtualLens2
2. Transform Control
3. Auto Leveler

Auto Horizon Leveling cancels out roll rotation of the camera, ensuring it remains horizontally or vertically aligned. If Auto Snap is selected, it snaps the rotation in 30-degree increments.

Stabilization

1. VirtualLens2
2. Transform Control
3. More
4. Stabilizer

Stabilization minimizes the impact of small tremors by gently modulating the camera’s movements and rotations. Enabling stabilization will replace the camera model with an alternative model to prevent reflections.

Fix to World Space

1. VirtualLens2
2. Transform Control
3. Drop/Reposition

Fixing the camera to the world space prevents it from following your hand movements.

Reposition

1. VirtualLens2
2. Transform Control
3. Drop/Reposition

Reposition mode allows the camera, which is fixed in the world space, to be moved manually. In this mode, the camera follows your hand movements as if you were physically near the camera.

Reposition Movement Scaling

1. VirtualLens2
2. Transform Control
3. More
4. Reposition Scale

In reposition mode, you can scale the camera’s movement based on your hand movement. The scaling factor can be set to 1x, 3x, 10x, or 30x. When set to 1x, the camera moves exactly as your hand moves.

Camera Retrieval

1. VirtualLens2
2. Transform Control
3. Pickup

Camera retrieval mode brings back the camera to your hand when it is fixed in the world space, repositioning, or any other state.

Save and Load Camera Positions

1. VirtualLens2
2. Transform Control
3. More
4. Pins

You can store up to four different camera positions and recall them later. To record the current camera position, press and hold Action Menu’s Pin [1-4] button for more than 1 second. To recall a stored position, press the corresponding Pin [1-4] button briefly to move the camera to the recorded location and fix it in the world space.

Drone Mode

1. VirtualLens2
2. Transform Control
3. Drone

Drone mode allows you to control the camera as if it were a drone. To enter drone mode, slightly extend both hands in front of you and select the Drone mode option from the Action Menu. In this mode, 2D Puppet opens, and you can control the camera’s orientation with the direction of your hand which was the camera attached and the left-right input of 2D Puppet. The direction and speed of camera movement are controlled using the gizmo and the white ball appearing at your hand’s location. Zoom control is managed by the up-down input of the 2D Puppet. The white ball constantly follows the controller hand and moves further away from the gizmo’s center to increase the movement speed. Additionally, by quickly flicking the stick left or right twice with the 2D Puppet, the drone’s orientation can be rotated by 180 degrees.

To exit Drone Mode, press the trigger button to close 2D Puppet. The camera will return to a fixed position in the world space.

2.4 - Other Features

Preset Recall

1. VirtualLens2
2. Quick Calls

You can recall preset settings that you prepared during setup. This allows you to quickly configure commonly used values for focal length, aperture, exposure, or a combination of these. For more details about preset settings, refer to the Configuration Reference.

Hide Specified Meshes

1. VirtualLens2
2. Advanced Settings
3. Mesh Visibility

You can hide specified meshes, which you set up during the configuration. Hiding these meshes affects all other players, but it won’t work if safety settings have disabled animations.

Preview Screen Info Display Settings

You can configure the information displayed on the preview screen. To change the default settings, adjust the parameters during setup.

Grid

1. VirtualLens2
2. Advanced Settings
3. Display Settings
4. Grid

This option lets you display gridlines on the preview screen. You can choose between options such as Hidden, 3x3, 3x3 with Diagonals, 6x4, or a Custom Grid.

Configuration Info

1. VirtualLens2
2. Advanced Settings
3. Display Settings
4. Information

This setting displays values like focal length, aperture, etc., in common units rather than percentage notation.

Level

1. VirtualLens2
2. Advanced Settings
3. Display Settings
4. Level

It shows a visual level that indicates the camera’s tilt.

Focus Peaking

1. VirtualLens2
2. Advanced Settings
3. Display Settings
4. Peaking

Focus peaking highlights the area in focus. You can choose to enable this feature at all times, only in manual focus mode, or disable it.

Mask Settings

1. VirtualLens2
2. Advanced Settings
3. Mask

When shooting with VirtualLens2, you can select which objects should be visible through the camera.

Local Player

1. VirtualLens2
2. Advanced Settings
3. Mask
4. Local Player

Choose whether to display the shooter’s own avatar.

Remote Players

1. VirtualLens2
2. Advanced Settings
3. Mask
4. Remote Player

Choose whether to display avatars of other players.

UI Elements

1. VirtualLens2
2. Advanced Settings
3. Mask
4. UI

You can select whether to show UI elements like nameplates and personal mirrors on the camera feed.

Preview HUD

1. VirtualLens2
2. Advanced Settings
3. Preview HUD

This feature prominently displays the preview screen at the center of your view.

Dealing with Scene-Dependent Issues

The constraints imposed by avatars incorporating cameras can lead to unexpected behavior depending on the world and instances. In such cases, VirtualLens2 includes options to address these issues, albeit with some trade-offs in performance or usability.

Clipping Plane Adjustment

1. VirtualLens2
2. Advanced Settings
3. Far Plane

Temporarily relax the restrictions on the clipping plane’s far side. This can be useful in extremely large worlds where distant objects might not be visible. However, excessive relaxation can lead to increased rendering load and z-fighting issues, so adjust the setting with caution.

Enable Depth Texture Generation

1. VirtualLens2
2. Advanced Settings
3. Depth Enabler

To use depth textures (_CameraDepthTexture) for specific effects, you need to enable this setting for the camera. While you can enable it in the world settings for built-in cameras, the avatar-incorporated camera may not activate depth textures. Enabling the Depth Enabler option in VirtualLens2 allows for the generation of depth textures in the camera you use for captures. This ensures correct rendering results, but it may come with a slight performance cost.

3 - Configuration Reference

3.1 - List of Configuration Parameters

The VirtualLens Settings component generated automatically during setup contains various parameters. By modifying these parameters and reapplying them, you can customize the behavior of VirtualLens2 to a certain extent.

General Settings

Build Mode

Choose whether to use non-destructive editing or destructive editing during the setup of VirtualLens2.

Avatar

Configure the avatar to be set up. It must have a VRCAvatarDescriptor component and be set up as a humanoid avatar. When using the non-destructive workflow, the avatar included in the object containing that VirtualLens Settings component will be the one set up.

Camera Object Settings

Camera Mesh Settings (Root Object, Non-Preview Root)

Configure the settings for the camera object displayed at hand when using VirtualLens2. For more details, refer to Replacing the Camera Model.

Auto Placement

Re-run the automatic placement of the camera mesh. This can be useful for resetting the placement or replacing the camera model later.

Marker Objects

Select objects used as reference points for position and orientation in various functions. You can customize related behaviors by adjusting the positions of these objects as needed.

Screen Touchers

These are objects used for touch screen hit detection. Normally, they are placed at the tip of the index finger of the hand without the camera.

Drone Controller

This is an object indicating the position for displaying the controller used to control speed in drone mode. It is usually located near the palm of the hand without the camera.

Reposition Origin

This is an object indicate the position corresponding to the point before the repositioning when using the repositioning mode. It is usually placed slightly in front of the chest.

Selfie Markers

These are objects representing the points to focus on when using the selfie autofocus. They are usually placed near the pupils of each eye.

Settings for Continuous Value Parameters

Focal Length

Set the upper and lower limits and default values of the focal length in values equivalent to full-frame sensors (35mm format).

Aperture

Set whether to implement depth of field simulation, and the upper and lower limits and default values for the aperture size in terms of F-stop.

Manual Focusing

Set whether to implement manual focusing, and the range of distances that can be focused on in meters.

Exposure Compensation

Set whether to implement exposure compensation and the range and default value for the compensation value in EV (exposure value).

Drone Function

Set whether to implement the drone function and configure parameters such as speed.

Clipping Planes

Set the range of the camera used by VirtualLens2 for shooting.

Control of External Objects

Optional Objects

Set objects that are enabled or disabled in conjunction with VirtualLens2. If the checkbox is enabled, the objects are enabled when VirtualLens2 is enabled and disabled when it is disabled. If the checkbox is disabled, the opposite occurs.

Hideable Meshes

Set objects for controlling visibility using the mesh hiding feature. If the feature is enabled, the enabled or disabled state of MeshRenderer or SkinnedMeshRenderer components in the specified objects will be controlled.

Calling Presets (Quick Calls)

Set up to 8 presets that can be called using the preset feature. Only the checked items for focal length, aperture, and exposure compensation will be updated to the specified values.

Display Settings for the Preview Screen

Changing Default Settings (Grid, Information, Level, Peaking)

Configure the items to be displayed on the preview screen by default. Each item and its value corresponds to the settings for preview screen information display.

カスタムグリッドの設定 (Custom Grids)

Register up to four images that can be used instead of a grid. It is recommended that the images meet the following requirements:

• Have opacity in the alpha channel (enable “Alpha is Transparency”)
• Have a resolution of 1280x720
• Disable automatic resizing to power-of-2
• Do not generate mip maps

You can refer the example (VirtualLens2/Textures/CustomGrid_Example.png) in the package.

Auto Focus Settings

Change the default settings for auto focus. Each item and its value correspond to the auto focus mode and parameters settings.

Settings for Image Processing Algorithms

Configure settings related to image quality and performance, such as parameters for depth of field simulation.

Advanced Settings

Settings for Modular Avatar Integration

This is displayed only when you are using a destructive setup while the Modular Avatar is imported into the project. For more details, also refer to Integration with Modular Avatar (Legacy).

3.2 - Replacing the Camera Model

Using VirtualLens2-Compatible Prefabs

If the package of the 3D model you want to use includes VirtualLens2-compatible prefabs, please refer to the documentation provided with the model data and setup guide. If the Prefab contains objects named VirtualLensOrigin and VirtualLensPreview, it is likely compatible with VirtualLens2.

Simple Replacement Procedure

Here, we’ll explain the procedure for displaying a 3D model as a camera when there are no VirtualLens2-compatible prefabs or setup instructions available. If you wish to create a prefab for sharing with other avatars or distribute a pre-configured mesh, please refer to the more detailed instructions below.

Preparations

If there is a default camera model, remove CompactCamera from the Hierarchy.

Placing the Template Prefab

Add VirtualLens2/Prefabs/CameraSkeleton.prefab to the scene.

Placing Custom Mesh

Place the mesh you want to use as a child of NonPreviewRoot. Since the camera captures from the position of VirtualLensOrigin, adjust the position of VirtualLensOrigin to be at the center of the lens or as needed. Also, be careful that no visible polygons are more than 0.05m away from the line of sight (positive Z-axis direction) from VirtualLensOrigin as this could cause reflections in the camera mesh.

Adjusting the Preview Screen Position

Adjust the position and size of the preview screen, including the touch screen PreviewWrapper. When doing this, make sure to set the Scale values (x, y, z) to the same value to maintain the aspect ratio.

Modifying Parent-Child Relationships within the Avatar

After adjusting the position of CameraSkeleton, move it to be a child of the objects you want to interact with.

Updating Settings

Update the settings in VirtualLens Settings under the “Camera Object” section as follows, then press the “Apply” button to apply the settings:

• Root Object: CameraSkeleton
• Non-Preview Root: NonPreviewRoot

Note that if you change the position of objects after applying the settings, you will need to press the “Apply” button again to update the settings.

Detailed Explanation

Reference Objects

VirtualLens2 uses objects with specific names as references to automatically generate various components. By preparing these objects appropriately, you can use your custom 3D model as a camera. In this section, we will explain how to position reference objects using the camera model included with VirtualLens2 (Assets/VirtualLens2/Prefabs/CompactCamera.prefab) as an example.

VirtualLensOrigin

This object serves as the reference when placing the camera component for capturing. The positive Z-axis of this object represents the front, and the positive Y-axis represents the up direction. The camera component is generated based on this orientation.

VirtualLensPreview

This object serves as the reference for interface placement to specify the focus point. The camera component for touch detection is generated based on the orientation and Y-axis scale of this object.

It’s worth noting that CompactCamera.prefab includes a MeshRenderer for the preview screen, but this is not mandatory. You have the option to render it on a different object or not render it at all.

Preview Material

A material for the preview screen is provided as Assets/VirtualLens2/Materials/VirtualLensPreview.mat. You can apply it to objects like a quad to generate a preview screen that includes touch information. You can find examples of its usage in the contents of the package, such as CompactCamera.prefab.

Distributing VirtualLens2-Compatible 3D Models

If you intend to distribute a 3D model designed for use with VirtualLens2, consider preparing a prefab that includes the reference objects mentioned earlier and uses the VirtualLensPreview.mat material for the preview screen. This will simplify the setup when integrating it with VirtualLens2. If you plan to distribute or sell your model, including such a prefab is a good idea.

3.3 - 4K Capturing

Basic Settings

VirtualLens2 Settings

During setup, enable the “Enable 4K Capturing” option found in VirtualLens Settings under Algorithm Settings.

VRChat Settings

In VRChat, select 4K (2160p) resolution from the Resolution menu in the built-in VRChat camera settings.

Considerations

Behavior When Settings Don’t Align

If the camera resolution in VRChat settings is something other than 3840x2160, VirtualLens2 will attempt to upscale or downscale the rendering results for 1920x1080. As a result, if the resolution is set to something other than 3840x2160 or 1920x1080, the image quality may degrade. Please be mindful of this.

Additionally, when 4K capture is enabled in VirtualLens2, the rendering results for 1920x1080 are slightly lower in quality, as they are intended for preview. Therefore, if the camera resolution setting in VRChat remains at the default (1920x1080), it may be advantageous not to enable the 4K capture option in terms of image quality.

Compatibility with Stream Camera

When using Stream Camera, the camera resolution matches the size of the desktop window. Therefore, without adjusting the window size properly, it may result in image quality degradation as mentioned when settings don’t align. If possible, it is recommended to use VRChat’s startup options to set the window to fullscreen at 3840x2160 (when 4K recording is enabled) or 1920x1080 (when 4K recording is disabled).

3.4 - Creating Setting Templates

VirtualLens2 has a variety of configuration parameters, and when you need to set up for multiple avatars with almost identical settings, it can become a time-consuming task to input the parameters repeatedly. In such cases, creating setting templates can help you streamline the process by skipping the input of common parameters.

Creating Setting Prefabs

Start by performing the setup using the standard procedure. The object with VirtualLens Settings that is generated during this setup can be turned into a setting prefab by dragging and dropping it into the project view. When doing this, you will be prompted to either create a new prefab or create a prefab variant. Generally, it is recommended to create it as a prefab variant.

v2.9.0-: A default setting prefab (VirtualLens2/Prefabs/DefaultSettings.prefab) is now provided. VirtualLens Settings created by the setup helper in versions prior to v2.8.x does not reference this prefab. Therefore, it is recommended to recreate the setting prefab for compatibility with future updates.

Using Setting Prefabs

When setting up VirtualLens2 for a new avatar, specify the prefab you created in the “Settings Template” field of the setup helper. This will enable the settings to be based on the template you created instead of using the default settings that come with VirtualLens2.

4 - Developer Guide

About Parameters

By reading and writing parameters used within VirtualLens2, you can control the behavior of VirtualLens2 from other gadgets. Below is a list of accessible parameters and their explanations.

Legend

• Synchronization
  • Synchronized Synchronized with other players.
  • Non-synchronized Not synchronized with other players.
  • Optional-synchronized Synchronized only if enabled during setup.
• Access control
  • Read/Write Both reading and writing are available.
  • Read only Read-only parameters. Changing them may cause unintended behavior.
  • Write only Write-only parameters. The values they take may not be explicitly defined.

Core Elements

VirtualLens2 Control

Synchronized Write only

Used for synchronization with other players, accepting menu input, and receiving control commands via OSC. It can only be used from external sources for sending commands.

Sending Control Commands

If you need to handle parameters not registered in VRCExpressionParameters via OSC, you can update them by writing following values to VirtualLens2 Control.

Show command lists

VirtualLens2 Enable

Synchronized Read/Write

Indicates whether VirtualLens2 is enabled. It is 1 when enabled and 0 when disabled.

VirtualLens2 AltMesh

Synchronized Read only

Indicates whether the camera model’s display is replaced with an alternate mesh. When the display is replaced, it is 1, otherwise 0.

Note that there is a difference in behavior between local and remote when it is handheld and image stabilization is enabled. In the local context, it is 1, while in the remote context, it is 0.

Basic Functions

VirtualLens2 Zoom

Optional-synchronized Read/Write

Set between 0.0 and 1.0 according to the focal length. You can calculate the conversion from parameter value \( x \) to focal length \( f \) using the following equation. Here, \( f_{\min} \) and \( f_{\max} \) correspond to the Min focal length and Max focal length in the setup items, respectively.

$$ f = f_{\min} \exp \Bigl\{ x \log \frac {f_{\max}} {f_{\min}} \Bigr\} $$

VirtualLens2 Aperture

Optional-synchronized Read/Write

Set between 0.0 and 1.0 according to the aperture (F number). You can calculate the conversion from parameter value \( x \) to F number using the following equation. Here, \( F_{\min} \) and \( F_{\max} \) correspond to the Min F number and Max F number in the setup items, respectively.

$$ F = F_{\min} \exp \Bigl\{ x \log \frac {F_{\max}} {F_{\min}} \Bigr\} $$

VirtualLens2 Exposure

Optional-synchronized Read/Write

Set between 0.0 and 1.0 according to the exposure compensation. You can calculate the conversion from parameter value \( x \) to correction value \( E \) [EV] using the following equation. Here, \( E_r \) corresponds to the Exposure Range in the setup items.

$$ E = (2x-1)E_{r} $$

Position and Orientation Control

VirtualLens2 PositionMode

Non-synchronized Read only

Indicates the current position adjustment mode. The correspondence between values and modes is as follows:

VirtualLens2 AutoLeveler

Non-synchronized Read/Write

Indicates the current auto-leveling mode. The correspondence between values and modes is as follows:

VirtualLens2 Stabilizer

Non-synchronized Read/Write

Indicates the current image stabilization mode. The correspondence between values and modes is as follows:

VirtualLens2 RepositionScale

Non-synchronized Read/Write

Sets the scaling factor for movement when using the reposition feature. The correspondence between values and multipliers is as follows:

VirtualLens2 LoadPin

Non-synchronized Write only

By writing a value in the range of 1 to 4, the camera is moved to the corresponding pin position.

VirtualLens2 StorePin

Non-synchronized Write only

By writing a value in the range of 1 to 4, the current camera position is registered as the position for the corresponding pin.

VirtualLens2 ExistPin[1-4]

Non-synchronized Read only

Indicates whether the corresponding pin position is registered. It is 1 when registered and 0 when not registered.

VirtualLens2 ExternalPose

Non-synchronized Read/Write

Indicates whether external pose input is enabled. It is 1 when enabled and 0 when disabled.

Focus Control

VirtualLens2 AFMode

Non-synchronized Read/Write

Indicates the autofocus mode. The correspondence between values and modes is as follows:

VirtualLens2 AFSpeed

Non-synchronized Read/Write

Indicates the speed of focus plane adjustment by autofocus. The correspondence between values and settings is as follows:

VirtualLens2 TrackingSpeed

Non-synchronized Read/Write

Indicates the speed at which, when using face detection autofocus, it switches to tracking another face after failing to detect a face. The correspondence between values and settings is as follows:

VirtualLens2 FocusLock

Non-synchronized Read/Write

A flag to temporarily stop updating the focus plane. When it is 1, the update of the focus plane is stopped, and when it becomes 0, it resumes.

VirtualLens2 Distance

Optional-synchronized Read/Write

Indicates the distance to the plane where the focus is set during manual focus, ranging from 0.0 to 1.0. You can calculate the conversion from parameter value \( x \) to distance \( D \) [m] using the following equation. Here, \( D_{\min} \) and \( D_{\max} \) correspond to the Min focus distance and Max focus distance in the setup items.

$$ D = D_{\min} \exp \Bigl\{ x \log \frac {D_{\max}} {D_{\min}} \Bigr\} $$

VirtualLens2 TouchOverride

Non-synchronized Read/Write

This flag is used to simulate touchscreen operations through avatar parameters. While set to 1, the coordinates specified by TouchOverrideX and TouchOverrideY are considered touched.

VirtualLens2 TouchOverrideX, VirtualLens2 TouchOverrideY

Non-synchronized Read/Write

When simulating touchscreen operations through the TouchOverride parameter, set the coordinates considered as touched in the range of -1.0 to 1.0 for both X and Y. The X coordinate increases from left to right, and the Y coordinate increases from bottom to top.

Screen Settings

VirtualLens2 Grid

Non-synchronized Read/Write

Sets the type of grid to display on the preview screen. The correspondence between values and types is as follows:

VirtualLens2 Information

Non-synchronized Read/Write

Sets whether to display information such as focal length and F number on the preview screen. It is 1 when displayed and 0 when not displayed.

VirtualLens2 Level

Non-synchronized Read/Write

Sets whether to display a level on the preview screen. It is 1 when displayed and 0 when not displayed.

VirtualLens2 Peaking

Non-synchronized Read/Write

Sets the condition for emphasizing the range with correct focus on the preview screen. The correspondence between values and conditions is as follows:

Mask Settings

VirtualLens2 LocalPlayerMask

Non-synchronized Read/Write

Select whether to reflect the shooter’s own avatar. Set to 1 if reflecting, 0 if not.

VirtualLens2 RemotePlayerMask

Non-synchronized Read/Write

Select whether to reflect avatars of players other than the shooter. Set to 1 if reflecting, 0 if not.

VirtualLens2 UIMask

Non-synchronized Read/Write

Select whether to reflect UI elements. Set to 1 if reflecting, 0 if not.

Other Settings

VirtualLens2 Hide

Synchronized Read/Write

Controls the visibility of meshes specified in Hideable Meshes. Set to 1 to hide and 0 to show.

VirtualLens2 PreviewHUD

Non-synchronized Read/Write

Controls the visibility of the preview HUD. Set to 1 to show and 0 to hide.

VirtualLens2 FarPlane

Non-synchronized Read/Write

Adjusts the culling distance on the far side. The correspondence between values and settings is as follows:

VirtualLens2 DepthEnabler

Non-synchronized Read/Write

Controls a mechanism to ensure the stable operation of shaders that depend on depth textures. It is 1 when enabled and 0 when disabled.

Reading Avatar Settings

VirtualLens2 Version

Non-synchronized Read only

If VirtualLens2 vX.Y.Z is set up, the integer value X * 10000 + Y * 100 + Z is set.

VirtualLens2 Zoom Min, VirtualLens2 Zoom Max

Non-synchronized Read only

Sets the lower and upper limits for the focal length, \( f_{\min} \), and \( f_{\max} \) in millimeters as floating-point numbers.

VirtualLens2 Aperture Min, VirtualLens2 Aperture Max

Non-synchronized Read only

Sets the lower and upper limits for the aperture (F number), \( F_{\min} \), and \( F_{\max} \) as floating-point numbers.

VirtualLens2 Exposure Range

Non-synchronized Read only

Sets the range of correction values, \( E_r \), used for exposure correction as a floating-point number.

VirtualLens2 Resolution X, VirtualLens2 Resolution Y

Non-synchronized Read only

Sets the expected resolution of images from VirtualLens2 as integers.

Usage Examples

Changing Hand Shape with Enabling and Disabling VirtualLens2

By referring to VirtualLens2 Enable and VirtualLens2 AltMesh, you can determine if VirtualLens2 is enabled and the camera mesh is displayed at the hand position. Based on these, if you want to change the hand shape, you can add states and transitions to the hand animation corresponding to the hand sign in the Gesture layer. If Gesture layers' parameter lists are not updated during VirtualLens2 setup, you need to manually add the parameters you want to use to the Animator Controller.

Focus Lock via Hand Sign Input

By using VRCAvatarParameterDriver to rewrite the VirtualLens2 FocusLock parameter, you can use the focus lock feature. Using this, you can add a layer to control parameters based on GestureLeft and GestureRight values to fix focus with specific hand signs.

External Pose Input

If the parameter VirtualLens2 ExternalPose is 1, the camera’s position and orientation will match the object specified in “External Pose Source” during setup, and the camera mesh will be replaced with an alternate model, as in the case of using the drone feature. This allows you to control the camera posture from Avatar Gadgets other than VirtualLens2.

Development Scripts

Scripts used for development, such as generating Animator Controllers and packaging, can be found in VirtualLens2/Core/Generators/Editor and VirtualLens2/Core/Scenes. If you are interested in the internal implementation of VirtualLens2, these scripts may be helpful. To use these scripts, you need to add VL2_DEVELOPMENT as a predefined macro in your project and introduce Animator As Code.

5 - Frequently Asked Questions

Introduction

First, please check for updates in the change log and the download page on Booth to see if there are any updates available. If you are experiencing issues with VirtualLens2 or if the symptoms are due to changes in VRChat client and/or SDK, these issues may have already been fixed by an update.

Setup-related Questions

My avatar’s expressions or gimmicks broke after installation.

In most cases, this is due to the “Write Defaults” settings. Adjust the “Enable Write Defaults” setting within VirtualLens Settings > Advanced Settings appropriately and reapply. You can find more information about “Write Defaults” in the VRChat official documentation.

VirtualLens2 tries to automatically adjust the settings based on the existing FX Layer’s Animator Controller during the setup. However, in cases like the following, it may fail to determine the settings, and manual adjustments are required:

You changed the settings after the setup. There was a mixture of “Write Defaults” settings during the setup.

Changing the Menu Item Installation Location

When using a non-destructive setup, adding the “MA Menu Installer” component to an object that has the VirtualLens Settings component allows menu items to be added according to its settings. By configuring the “Install To” parameter of the added component correctly, you can change the installation location of menu items.

Operation-related Questions

When I switch to Drone Mode, the camera flies off somewhere.

VirtualLens2’s drone function is controlled using the position of the hand without the camera. Therefore, if you move the controlling hand unintentionally, the drone might fly in unintended directions or at unintended speeds. When transitioning to Drone Mode, try operating the menu with both hands lightly extended forward.

Miscellaneous Questions

I want the camera to be visible to others when using the drone function.

Currently, due to constraints in VRChat, correctly synchronizing the camera’s position with others is challenging. Therefore, it is intentionally configured to not be visible to others.

I want to improve my performance rank.

The current method of calculating performance rank counts even objects that are only used locally, so complex local gimmicks like VirtualLens2 tend to have a worse ranking than the actual load when viewed by others. In most cases, when viewed by others, most objects are never activated, and they don’t significantly contribute to the performance. If VRChat’s specifications change in the future to allow correct handling of local objects, we will provide an update to address this.

Reference: [FEEDBACK] Mark local objects explicitly and exclude them from performance rank calculation

When Things Go Wrong or You Don’t Understand

If you encounter issues or have questions, please contact via the messaging system on Booth or through Twitter DM. Since image sharing is often necessary, contacting via Twitter DM is recommended. In your message, please include the following information to help streamline the communication:

• Whether there were any errors displayed in the console when you clicked the “Apply” button.
• Screenshots of the VirtualLensSettings.
• Screenshots of the VRC_AvatarDescriptor.
• Screenshots of the AV3 Debug screen in VRChat (can be displayed by going to Puppet Menu > Options > Config > Debug).

6 - Changelog

VirtualLens2 v2.10.x

Version 2.10.2 (2024-01-29)

• Implemented the use of NDMF’s error reporting interface when using NDMF 1.3.0 and later.
• Added quick turn feature for drone mode.
• Zooming is assigned to up and down on 2D puppet in drone mode.
• Automatically generates MA Menu Installer to control the placement of menu buttons during non-destructive setup.
• Added API to simulate screen touches from avatar parameters (TouchOverride*).
• Fixed an issue where version checks fail in environments with specific editor extensions like VRCFury or Av3Emulator.
• Prevents shadows from being cast by alternative camera meshes used in Drone Mode and similar modes.
• Added error check for existing Animator Controllers where Avatars 3.0 standard parameters exist with unexpected types.
• Changed to allow setup of existing Animator Controller with Avatars 3.0 standard parameters even if they exist with different initial values than expected.
• Fixed an issue where setup fails if VirtualLensPreview is not present.

Version 2.10.1 (2023-11-05)

• Fixed an issue where the camera’s movements may be stuttered in Drone Mode.
• Updated the object path duplication check to consider object movement by MA Bone Proxy.
• Corrected the behavior when parts of the camera mesh are specified as Hideable Meshes.
• Enabled video output without the built-in camera in Desktop Mode.

Version 2.10.0 (2023-11-03)

• Officially added support for non-destructive setup using Modular Avatar and NDM Framework.
  • With this, the standard setup process has also transitioned to a non-destructive setup.
  • For migrating from the previous destructive setup, please refer to the upgrade guide.
• Added auto-snap mode to the auto horizon leveling feature.
• Introduced the preview HUD feature.
• Included the custom grid feature.
• Implemented the layer mask configuration feature.
• Introduced Remote Only Mode, focusing on implementing only the necessary features for avatar display on remote environment.
  • Designed for use in mobile platforms such as Android.
• API: Operating via the VirtualLens2 Control parameter is now deprecated.
  • Thanks to updates in VRCSDK, you can now directly operate parameters that are not synchronized, so please use that method.
• API: Part of the configuration information used during setup is now delivered as parameters.
• Improved performance related to Animator Controller.
• Fixed issues where it did not work correctly when used with MSAA disabled settings in VRChat 2023.4.1 and later.

VirtualLens2 v2.9.x and Older

For update history prior to this, please refer to the Japanese version page.

7 - Readme

VirtualLens2

Thank you for purchasing VirtualLens2.

This tool is a VR camera extension designed to be integrated into VRChat avatars. It allows for easy adjustments to the field of view without post-processing image degradation and enables post-effects using depth information.

For setup and updates, please refer to the provided web page with detailed instructions: https://vlens2.logilabo.dev/en/docs/

Terms of Use

• The author assumes no responsibility for any claims, damages, or other obligations arising from the use of this tool.
• Regardless of whether modifications are made or not, redistributing any portion or the entirety of this tool is prohibited.
• You are prohibited from making avatars, including components generated using this tool, available to third parties.
  • Example: Uploading as public avatars or distributing Prefabs

Third-Party Licenses

This package includes the following software and some of its components. Please refer to the included LICENSE.txt for the licensing terms of each software.

• FXAA: https://developer.nvidia.com
• SMAA: https://github.com/iryoku/smaa

Contacts

• ろじっく (twitter: @logi9_)
• Booth: https://logilabo.booth.pm/