RealityServer Document Center > Server APIs > V8 Javascript API

V8 Javascript API

Class Members

Here is a list of all documented class members with links to the class documentation for each member:

A

add(): RS.Math.Color; RS.Math.Spectrum; RS.Math.Vector3; RS.Math.Vector4; RS.Math.Vector2
adjust_gamma(): Canvas
all(): Mdl_arguments; Attributes
aperture: Camera
area_radius: Light
area_shape: Light
area_size: Light
arguments: Command; Mdl_instance
as(): Element
aspect: Camera
assert(): console
atime: fs.Stats
attach(): Mdl_arguments; Group
attached(): Mdl_arguments
attached_function: Mdl_attached_function
Attribute_container(): Attribute_container
attributes: Element
authenticate_redirects: http.Request

B

backplate_background_color: Camera
backplate_dof_enabled: Camera
backplate_function: Camera
backplate_lens_effects_enabled: Camera
backplate_tonemapping_enabled: Camera
base64(): Lightprofile
Bbox3(): RS.Math.Bbox3
Binary(): Binary
body: http.Request; http.Response
bounding_box: Scene
Bsdf_measurement(): Bsdf_measurement
byteLength: Binary
bytes_per_component: Canvas

C

namespace: Command
Camera(): Camera
camera_instance: Scene
Canvas(): Canvas
canvas: Image
cie_intensity(): RS.Math.Color; RS.Math.Spectrum
clear(): Binary; Group; RS.Math.Matrix4x4
clip_light: Section_object
clip_max: Camera
clip_min: Camera
clipping_box: Decal
clone(): Canvas; RS.Math.Color; RS.Math.Matrix4x4; RS.Math.Spectrum; RS.Math.Vector2; RS.Math.Vector3; RS.Math.Vector4; RS.Math.Bbox3
close(): fs; fs.async.File_handle
code: http.Response; http.Error; RS.Error
Color(): RS.Math.Color
COMMAND_INVALID_PARAMS: RS.Error
COMMAND_NEURAY_ERROR: RS.Error
COMMAND_NOT_FOUND: RS.Error
COMMAND_PERMISSION_DENIED: RS.Error
commit(): Polygon_mesh; Triangle_mesh
components_per_pixel: Canvas
compression: Texture
Configuration: RS
connect_timeout: http.Request
convert(): Canvas
copy(): Element
corners: Polygon_mesh
create(): Mdl_material_instance; Polygon_mesh; Triangle_mesh; Mdl_function_call; Element
create_child(): Scope
create_render_context(): Scene
crop(): Canvas
cross(): RS.Math.Vector4; RS.Math.Vector3
ctime: fs.Stats
current(): Scope

D

data: Binary; Canvas; RS.Error
data_size: Binary
debug(): console
Decal(): Decal
decode(): Canvas
default: Command.Argument
definition: Mdl_instance
degree: Lightprofile
delete(): Store; Element; http; http.async; Render_context; Scope
description: Command; Command.Argument; Command.Return_type
detach(): Group
disable: Element_scene_graph
distance(): RS.Math.Vector2; RS.Math.Vector3; RS.Math.Vector4
divide(): RS.Math.Vector3; RS.Math.Vector4; RS.Math.Vector2
dot(): RS.Math.Vector2; RS.Math.Vector4; RS.Math.Vector3

E

Element(): Element
Element_scene_graph(): Element_scene_graph
encode(): Canvas
encoding: http.Request
equal(): RS.Math.Vector2; RS.Math.Vector3; RS.Math.Color; RS.Math.Vector4; RS.Math.Matrix4x4; RS.Math.Spectrum
equal_with_tolerance(): RS.Math.Vector4; RS.Math.Color; RS.Math.Matrix4x4; RS.Math.Spectrum; RS.Math.Vector2; RS.Math.Vector3
Error(): RS.Error
error(): console
EVENT_HANDLER_NAME_INVALID: RS.Error
EVENT_NO_HANDLERS: RS.Error
executable: fs.Stats
execute: Command; RS
exists: Instance; Image; Group; Freeform_surface; Decal; Camera; Bsdf_measurement; Options; Mdl_function_call; Attributes; Scope; Irradiance_probes; Section_object; Lightprofile; Polygon_mesh; Mdl_material_instance; Scene; Triangle_mesh; Texture; Element; Subdivision_surface; Light; Mdl_arguments; Projector; Render_context; Attribute_container
export(): Scene
exports: Module
extract(): zip; zip.async

F

face_mode: Decal
FAILED: RS.Error
fd: fs.File_descriptor
field: Mdl_attached_function
filename: Bsdf_measurement; Image; Lightprofile
flags: Lightprofile
focal: Camera
follow_redirects: http.Request
frame_camera(): Scene
frame_time: Camera
Freeform_surface(): Freeform_surface

G

gamma: Canvas; Texture
gamma_correct(): RS.Math.Spectrum; RS.Math.Color
Geometry(): Geometry
get(): http.async; Mdl_arguments; Store; Attributes; http
get_data(): Canvas
get_determinant(): RS.Math.Matrix4x4
get_last_render(): Render_context
get_option(): Render_context
get_pixel(): Canvas
get_propagation(): Attributes
get_render_context(): Scene
get_type(): Mdl_arguments; Attributes
global(): Scope
Group(): Group
groups: Command

H

head(): http; http.async
headers: http.Response; http.Request
height: Canvas
hide: Element_scene_graph
holes: Polygon_mesh

I

id: Module
image: Texture
Image(): Image
import(): Scene
import_elements(): Scene
info(): console
Instance(): Instance
INVALID_OPERATION: RS.Error
INVALID_PARAMETERS: RS.Error
invert(): RS.Math.Matrix4x4
irradiance_probes: Camera
Irradiance_probes(): Irradiance_probes
is_black(): RS.Math.Color; RS.Math.Spectrum
is_colinear(): RS.Math.Vector3; RS.Math.Vector4; RS.Math.Vector2
is_null_vector(): RS.Math.Vector2; RS.Math.Vector3; RS.Math.Vector4
is_string(): Utils
isDirectory(): fs.Stats
isFile(): fs.Stats
item: Instance
items: Group

J

json: http.Request

K

keys(): Store

L

last_result: Render_context
layers: Canvas
length(): RS.Math.Vector2; RS.Math.Vector3; Group; RS.Math.Vector4
levels: Image
Light(): Light
Lightprofile(): Lightprofile
linear_intensity(): RS.Math.Color; RS.Math.Spectrum
localize(): Element
log(): console

M

maintain_request_methods: http.Request
material: Element_scene_graph
material_ids: Triangle_mesh; Polygon_mesh
material_override: Element_scene_graph
matrix: Instance
Matrix4x4(): RS.Math.Matrix4x4
max_displacement: Geometry
max_redirects: http.Request
Mdl_attached_function(): Mdl_attached_function
Mdl_function_call(): Mdl_function_call
Mdl_instance(): Mdl_instance
Mdl_material_instance(): Mdl_material_instance
MEMORY: RS.Error
mesh: Triangle_mesh; Polygon_mesh
message: http.Response; http.Error; RS.Error
metadata: Command
method: http.Request
mime_type: Binary
mkdir(): fs; fs.async
mtime: fs.Stats
multiply(): RS.Math.Vector2; RS.Math.Vector4; RS.Math.Matrix4x4; RS.Math.Vector3

N

name: Command; Element; Scope; Render_context
names(): Store
NEURAY: RS.Error
NONE: RS.Error
normal_indices: Polygon_mesh; Triangle_mesh
normalize(): RS.Math.Vector3; RS.Math.Vector2; RS.Math.Vector4
normals: Triangle_mesh; Polygon_mesh
NOT_FOUND: RS.Error
ntsc_intensity(): RS.Math.Color; RS.Math.Spectrum

O

offsets: Polygon_mesh
open(): fs; fs.async
Options(): Options
options: Scene; http; http.async
original_filename: Image
orthographic: Camera

P

parent: Scope
patch(): http; http.async
pick(): Render_context
pixel_type: Image
plane_shift: Camera
point_indices: Polygon_mesh; Triangle_mesh
points: Polygon_mesh; Triangle_mesh
Polygon_mesh(): Polygon_mesh
post(): http; http.async
priority: Decal
probes: Irradiance_probes
Progress(): RS
Projector(): Projector
projector: Projector; Decal
property_get(): Element
property_set(): Element
put(): http; http.async

R

read(): fs; fs.async.File_handle
readable: fs.Stats
readFile(): fs; fs.async
remove(): Attributes
render(): Render_context; Scene; Render_context
Render_context(): Render_context
render_to_ascii(): Render_context; Scene
render_to_base64(): Scene; Render_context
render_to_canvas(): Render_context; Scene
render_to_canvases(): Render_context; Scene
render_to_disk(): Render_context; Scene
renderer: Render_context
reset_canvas(): Image
reset_file(): Image
resize(): Canvas
resolution: Lightprofile; Image; Camera
resolution_x: Camera; Canvas
resolution_y: Canvas; Camera
returns: Command
rmdir(): fs.async; fs
root_group: Scene
rotate(): RS.Math.Vector3; RS.Math.Vector4
rotate_to(): RS.Math.Vector4; RS.Math.Vector3
rotate_transpose(): RS.Math.Vector4; RS.Math.Vector3
rotate_transpose_to(): RS.Math.Vector4; RS.Math.Vector3

S

save_to_disk(): Image
scale(): RS.Math.Color; RS.Math.Vector2; RS.Math.Vector3; RS.Math.Spectrum; RS.Math.Vector4
scene: Render_context
Scene(): Scene
Scope(): Scope
scope: Render_context
Section_object(): Section_object
selector: Image; Texture
send(): http; http.async
set(): Attributes; RS.Math.Bbox3; RS.Math.Color; RS.Math.Matrix4x4; Mdl_arguments; RS.Math.Spectrum; Store; RS.Math.Vector2; RS.Math.Vector3; RS.Math.Vector4
set_data(): Binary
set_filename(): Lightprofile
set_identity(): RS.Math.Matrix4x4
set_material(): Element_scene_graph
set_option(): Render_context
set_options(): Render_context
set_pixel(): Canvas
set_propagation(): Attributes
set_rotation(): RS.Math.Matrix4x4
set_scaling(): RS.Math.Matrix4x4
set_translation(): RS.Math.Matrix4x4
shutter_close: Options
shutter_open: Options
size: fs.Stats
Spectrum(): RS.Math.Spectrum
stat(): fs.async; fs
stride: Canvas
strings_to_elements(): Utils
sub_window: Camera
Subdivision_surface(): Subdivision_surface
subtract(): RS.Math.Spectrum; RS.Math.Color; RS.Math.Vector2; RS.Math.Vector3; RS.Math.Vector4

T

tagged: Polygon_mesh; Triangle_mesh
Tainted: RS
Texture(): Texture
texture_space: Decal; Projector
time(): console
timeEnd(): console
timeout: http.Request; Render_context
timeStamp(): console
tint(): RS.Math.Color; RS.Math.Spectrum
toString(): RS.Math.Matrix4x4; RS.Math.Spectrum; RS.Math.Vector2; RS.Math.Vector3; RS.Math.Vector4; RS.Math.Bbox3; RS.Math.Color
transform(): RS.Math.Vector3; RS.Math.Vector4
transform_to(): RS.Math.Vector3; RS.Math.Vector4
transform_transpose(): RS.Math.Vector3; RS.Math.Vector4
transform_transpose_to(): RS.Math.Vector3; RS.Math.Vector4
translate(): RS.Math.Matrix4x4
transpose(): RS.Math.Matrix4x4
Triangle_mesh(): Triangle_mesh
type: Light; Command.Argument; Canvas; Command.Return_type
type_name: Element

U

unlink(): fs; fs.async
url: http.Request
use(): Scope
user: Polygon_mesh; Triangle_mesh
user_indices: Triangle_mesh; Polygon_mesh
user_names: Polygon_mesh; Triangle_mesh
user_sizes: Polygon_mesh; Triangle_mesh
uuid(): Utils
uv_indices: Polygon_mesh; Triangle_mesh
uv_sizes: Triangle_mesh; Polygon_mesh
uvs: Triangle_mesh; Polygon_mesh

V

Vector2(): RS.Math.Vector2
Vector3(): RS.Math.Vector3
Vector4(): RS.Math.Vector4
verify_ssl: http.Request
volume: Texture

W

warn(): console
width: Canvas
write(): fs; fs.async.File_handle; fs
writeable: fs.Stats
writeFile(): fs; fs.async