- _init
void _init()
Initializes the visual server.
- blackBarsSetImages
void blackBarsSetImages(RID left, RID top, RID right, RID bottom)
Sets images to be rendered in the window margin.
- blackBarsSetMargins
void blackBarsSetMargins(long left, long top, long right, long bottom)
Sets margin size, where black bars (or images, if blackBarsSetImages was used) are rendered.
- cameraCreate
RID cameraCreate()
- cameraSetCullMask
void cameraSetCullMask(RID camera, long layers)
- cameraSetEnvironment
void cameraSetEnvironment(RID camera, RID env)
- cameraSetOrthogonal
void cameraSetOrthogonal(RID camera, double size, double z_near, double z_far)
- cameraSetPerspective
void cameraSetPerspective(RID camera, double fovy_degrees, double z_near, double z_far)
- cameraSetTransform
void cameraSetTransform(RID camera, Transform transform)
- cameraSetUseVerticalAspect
void cameraSetUseVerticalAspect(RID camera, bool enable)
- canvasCreate
RID canvasCreate()
Creates a canvas and returns the assigned RID.
- canvasItemAddCircle
void canvasItemAddCircle(RID item, Vector2 pos, double radius, Color color)
Adds a circle command to the CanvasItem's draw commands.
- canvasItemAddClipIgnore
void canvasItemAddClipIgnore(RID item, bool ignore)
If ignore is true, the VisualServer does not perform clipping.
- canvasItemAddLine
void canvasItemAddLine(RID item, Vector2 from, Vector2 to, Color color, double width, bool antialiased)
Adds a line command to the CanvasItem's draw commands.
- canvasItemAddMesh
void canvasItemAddMesh(RID item, RID mesh, RID texture, RID normal_map)
Adds a Mesh to the CanvasItem's draw commands. Only affects its aabb at the moment.
- canvasItemAddMultimesh
void canvasItemAddMultimesh(RID item, RID mesh, RID texture, RID normal_map)
Adds a MultiMesh to the CanvasItem's draw commands. Only affects its aabb at the moment.
- canvasItemAddNinePatch
void canvasItemAddNinePatch(RID item, Rect2 rect, Rect2 source, RID texture, Vector2 topleft, Vector2 bottomright, long x_axis_mode, long y_axis_mode, bool draw_center, Color modulate, RID normal_map)
Adds a nine patch image to the CanvasItem's draw commands.
See NinePatchRect for more explanation.
- canvasItemAddParticles
void canvasItemAddParticles(RID item, RID particles, RID texture, RID normal_map, long h_frames, long v_frames)
Adds a particles system to the CanvasItem's draw commands.
- canvasItemAddPolygon
void canvasItemAddPolygon(RID item, PoolVector2Array points, PoolColorArray colors, PoolVector2Array uvs, RID texture, RID normal_map, bool antialiased)
Adds a polygon to the CanvasItem's draw commands.
- canvasItemAddPolyline
void canvasItemAddPolyline(RID item, PoolVector2Array points, PoolColorArray colors, double width, bool antialiased)
Adds a polyline, which is a line from multiple points with a width, to the CanvasItem's draw commands.
- canvasItemAddPrimitive
void canvasItemAddPrimitive(RID item, PoolVector2Array points, PoolColorArray colors, PoolVector2Array uvs, RID texture, double width, RID normal_map)
Adds a primitive to the CanvasItem's draw commands.
- canvasItemAddRect
void canvasItemAddRect(RID item, Rect2 rect, Color color)
Adds a rectangle to the CanvasItem's draw commands.
- canvasItemAddSetTransform
void canvasItemAddSetTransform(RID item, Transform2D transform)
Adds a Transform2D command to the CanvasItem's draw commands.
This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item.
- canvasItemAddTextureRect
void canvasItemAddTextureRect(RID item, Rect2 rect, RID texture, bool tile, Color modulate, bool transpose, RID normal_map)
Adds a textured rect to the CanvasItem's draw commands.
- canvasItemAddTextureRectRegion
void canvasItemAddTextureRectRegion(RID item, Rect2 rect, RID texture, Rect2 src_rect, Color modulate, bool transpose, RID normal_map, bool clip_uv)
Adds a texture rect with region setting to the CanvasItem's draw commands.
- canvasItemAddTriangleArray
void canvasItemAddTriangleArray(RID item, PoolIntArray indices, PoolVector2Array points, PoolColorArray colors, PoolVector2Array uvs, PoolIntArray bones, PoolRealArray weights, RID texture, long count, RID normal_map)
- canvasItemClear
void canvasItemClear(RID item)
Clears the CanvasItem and removes all commands in it.
- canvasItemCreate
RID canvasItemCreate()
Creates a new CanvasItem and returns its RID.
- canvasItemSetClip
void canvasItemSetClip(RID item, bool clip)
Sets clipping for the CanvasItem.
- canvasItemSetCopyToBackbuffer
void canvasItemSetCopyToBackbuffer(RID item, bool enabled, Rect2 rect)
Sets the CanvasItem to copy a rect to the backbuffer.
- canvasItemSetCustomRect
void canvasItemSetCustomRect(RID item, bool use_custom_rect, Rect2 rect)
Defines a custom drawing rectangle for the CanvasItem.
- canvasItemSetDistanceFieldMode
void canvasItemSetDistanceFieldMode(RID item, bool enabled)
- canvasItemSetDrawBehindParent
void canvasItemSetDrawBehindParent(RID item, bool enabled)
Sets CanvasItem to be drawn behind its parent.
- canvasItemSetDrawIndex
void canvasItemSetDrawIndex(RID item, long index)
Sets the index for the CanvasItem.
- canvasItemSetLightMask
void canvasItemSetLightMask(RID item, long mask)
The light mask. See LightOccluder2D for more information on light masks.
- canvasItemSetMaterial
void canvasItemSetMaterial(RID item, RID material)
Sets a new material to the CanvasItem.
- canvasItemSetModulate
void canvasItemSetModulate(RID item, Color color)
Sets the color that modulates the CanvasItem and its children.
- canvasItemSetParent
void canvasItemSetParent(RID item, RID parent)
Sets the parent for the CanvasItem.
- canvasItemSetSelfModulate
void canvasItemSetSelfModulate(RID item, Color color)
Sets the color that modulates the CanvasItem without children.
- canvasItemSetSortChildrenByY
void canvasItemSetSortChildrenByY(RID item, bool enabled)
Sets if CanvasItem's children should be sorted by y-position.
- canvasItemSetTransform
void canvasItemSetTransform(RID item, Transform2D transform)
Sets the CanvasItem's Transform2D.
- canvasItemSetUseParentMaterial
void canvasItemSetUseParentMaterial(RID item, bool enabled)
Sets if the CanvasItem uses its parent's material.
- canvasItemSetVisible
void canvasItemSetVisible(RID item, bool visible)
Sets if the canvas item (including its children) is visible.
- canvasItemSetZAsRelativeToParent
void canvasItemSetZAsRelativeToParent(RID item, bool enabled)
If this is enabled, the z-index of the parent will be added to the children's z-index.
- canvasItemSetZIndex
void canvasItemSetZIndex(RID item, long z_index)
Sets the CanvasItem's z-index, i.e. its draw order (lower indexes are drawn first).
- canvasLightAttachToCanvas
void canvasLightAttachToCanvas(RID light, RID canvas)
Attaches the canvas light to the canvas. Removes it from its previous canvas.
- canvasLightCreate
RID canvasLightCreate()
- canvasLightOccluderAttachToCanvas
void canvasLightOccluderAttachToCanvas(RID occluder, RID canvas)
Attaches a light occluder to the canvas. Removes it from its previous canvas.
- canvasLightOccluderCreate
RID canvasLightOccluderCreate()
Creates a light occluder.
- canvasLightOccluderSetEnabled
void canvasLightOccluderSetEnabled(RID occluder, bool enabled)
Enables or disables light occluder.
- canvasLightOccluderSetLightMask
void canvasLightOccluderSetLightMask(RID occluder, long mask)
The light mask. See LightOccluder2D for more information on light masks
- canvasLightOccluderSetPolygon
void canvasLightOccluderSetPolygon(RID occluder, RID polygon)
Sets a light occluder's polygon.
- canvasLightOccluderSetTransform
void canvasLightOccluderSetTransform(RID occluder, Transform2D transform)
Sets a light occluder's Transform2D.
- canvasLightSetColor
void canvasLightSetColor(RID light, Color color)
Sets the color for a light.
- canvasLightSetEnabled
void canvasLightSetEnabled(RID light, bool enabled)
Enables or disables a canvas light.
- canvasLightSetEnergy
void canvasLightSetEnergy(RID light, double energy)
Sets a canvas light's energy.
- canvasLightSetHeight
void canvasLightSetHeight(RID light, double height)
Sets a canvas light's height.
- canvasLightSetItemCullMask
void canvasLightSetItemCullMask(RID light, long mask)
The light mask. See LightOccluder2D for more information on light masks
- canvasLightSetItemShadowCullMask
void canvasLightSetItemShadowCullMask(RID light, long mask)
The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See LightOccluder2D for more information on light masks.
- canvasLightSetLayerRange
void canvasLightSetLayerRange(RID light, long min_layer, long max_layer)
The layer range that gets rendered with this light.
- canvasLightSetMode
void canvasLightSetMode(RID light, long mode)
The mode of the light, see CANVAS_LIGHT_MODE_* constants.
- canvasLightSetScale
void canvasLightSetScale(RID light, double scale)
- canvasLightSetShadowBufferSize
void canvasLightSetShadowBufferSize(RID light, long size)
Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
- canvasLightSetShadowColor
void canvasLightSetShadowColor(RID light, Color color)
Sets the color of the canvas light's shadow.
- canvasLightSetShadowEnabled
void canvasLightSetShadowEnabled(RID light, bool enabled)
Enables or disables the canvas light's shadow.
- canvasLightSetShadowFilter
void canvasLightSetShadowFilter(RID light, long filter)
Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER_* constants.
- canvasLightSetShadowGradientLength
void canvasLightSetShadowGradientLength(RID light, double length)
Sets the length of the shadow's gradient.
- canvasLightSetShadowSmooth
void canvasLightSetShadowSmooth(RID light, double smooth)
Smoothens the shadow. The lower, the more smooth.
- canvasLightSetTexture
void canvasLightSetTexture(RID light, RID texture)
- canvasLightSetTextureOffset
void canvasLightSetTextureOffset(RID light, Vector2 offset)
- canvasLightSetTransform
void canvasLightSetTransform(RID light, Transform2D transform)
Sets the canvas light's Transform2D.
- canvasLightSetZRange
void canvasLightSetZRange(RID light, long min_z, long max_z)
- canvasOccluderPolygonCreate
RID canvasOccluderPolygonCreate()
Creates a new light occluder polygon.
- canvasOccluderPolygonSetCullMode
void canvasOccluderPolygonSetCullMode(RID occluder_polygon, long mode)
Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE_* constants.
- canvasOccluderPolygonSetShape
void canvasOccluderPolygonSetShape(RID occluder_polygon, PoolVector2Array shape, bool closed)
Sets the shape of the occluder polygon.
- canvasOccluderPolygonSetShapeAsLines
void canvasOccluderPolygonSetShapeAsLines(RID occluder_polygon, PoolVector2Array shape)
Sets the shape of the occluder polygon as lines.
- canvasSetItemMirroring
void canvasSetItemMirroring(RID canvas, RID item, Vector2 mirroring)
A copy of the canvas item will be drawn with a local offset of the mirroring Vector2.
- canvasSetModulate
void canvasSetModulate(RID canvas, Color color)
Modulates all colors in the given canvas.
- directionalLightCreate
RID directionalLightCreate()
- draw
void draw(bool swap_buffers, double frame_step)
- environmentCreate
RID environmentCreate()
- environmentSetAdjustment
void environmentSetAdjustment(RID env, bool enable, double brightness, double contrast, double saturation, RID ramp)
- environmentSetAmbientLight
void environmentSetAmbientLight(RID env, Color color, double energy, double sky_contibution)
- environmentSetBackground
void environmentSetBackground(RID env, long bg)
- environmentSetBgColor
void environmentSetBgColor(RID env, Color color)
- environmentSetBgEnergy
void environmentSetBgEnergy(RID env, double energy)
- environmentSetCanvasMaxLayer
void environmentSetCanvasMaxLayer(RID env, long max_layer)
- environmentSetDofBlurFar
void environmentSetDofBlurFar(RID env, bool enable, double distance, double transition, double far_amount, long quality)
- environmentSetDofBlurNear
void environmentSetDofBlurNear(RID env, bool enable, double distance, double transition, double far_amount, long quality)
- environmentSetFog
void environmentSetFog(RID env, bool enable, Color color, Color sun_color, double sun_amount)
- environmentSetFogDepth
void environmentSetFogDepth(RID env, bool enable, double depth_begin, double depth_curve, bool transmit, double transmit_curve)
- environmentSetFogHeight
void environmentSetFogHeight(RID env, bool enable, double min_height, double max_height, double height_curve)
- environmentSetGlow
void environmentSetGlow(RID env, bool enable, long level_flags, double intensity, double strength, double bloom_threshold, long blend_mode, double hdr_bleed_threshold, double hdr_bleed_scale, bool bicubic_upscale)
- environmentSetSky
void environmentSetSky(RID env, RID sky)
- environmentSetSkyCustomFov
void environmentSetSkyCustomFov(RID env, double scale)
- environmentSetSsao
void environmentSetSsao(RID env, bool enable, double radius, double intensity, double radius2, double intensity2, double bias, double light_affect, double ao_channel_affect, Color color, long quality, long blur, double bilateral_sharpness)
- environmentSetSsr
void environmentSetSsr(RID env, bool enable, long max_steps, double fade_in, double fade_out, double depth_tolerance, bool roughness)
- environmentSetTonemap
void environmentSetTonemap(RID env, long tone_mapper, double exposure, double white, bool auto_exposure, double min_luminance, double max_luminance, double auto_exp_speed, double auto_exp_grey)
- finish
void finish()
Removes buffers and clears testcubes.
- forceDraw
void forceDraw(bool swap_buffers, double frame_step)
- forceSync
void forceSync()
- freeRid
void freeRid(RID rid)
Tries to free an object in the VisualServer.
- getRenderInfo
long getRenderInfo(long info)
Returns a certain information, see RENDER_INFO_* for options.
- getTestCube
RID getTestCube()
Returns the id of the test cube. Creates one if none exists.
- getTestTexture
RID getTestTexture()
Returns the id of the test texture. Creates one if none exists.
- getWhiteTexture
RID getWhiteTexture()
Returns the id of a white texture. Creates one if none exists.
- giProbeCreate
RID giProbeCreate()
- giProbeGetBias
double giProbeGetBias(RID probe)
- giProbeGetBounds
AABB giProbeGetBounds(RID probe)
- giProbeGetCellSize
double giProbeGetCellSize(RID probe)
- giProbeGetDynamicData
PoolIntArray giProbeGetDynamicData(RID probe)
- giProbeGetDynamicRange
long giProbeGetDynamicRange(RID probe)
- giProbeGetEnergy
double giProbeGetEnergy(RID probe)
- giProbeGetNormalBias
double giProbeGetNormalBias(RID probe)
- giProbeGetPropagation
double giProbeGetPropagation(RID probe)
- giProbeGetToCellXform
Transform giProbeGetToCellXform(RID probe)
- giProbeIsCompressed
bool giProbeIsCompressed(RID probe)
- giProbeIsInterior
bool giProbeIsInterior(RID probe)
- giProbeSetBias
void giProbeSetBias(RID probe, double bias)
- giProbeSetBounds
void giProbeSetBounds(RID probe, AABB bounds)
- giProbeSetCellSize
void giProbeSetCellSize(RID probe, double range)
- giProbeSetCompress
void giProbeSetCompress(RID probe, bool enable)
- giProbeSetDynamicData
void giProbeSetDynamicData(RID probe, PoolIntArray data)
- giProbeSetDynamicRange
void giProbeSetDynamicRange(RID probe, long range)
- giProbeSetEnergy
void giProbeSetEnergy(RID probe, double energy)
- giProbeSetInterior
void giProbeSetInterior(RID probe, bool enable)
- giProbeSetNormalBias
void giProbeSetNormalBias(RID probe, double bias)
- giProbeSetPropagation
void giProbeSetPropagation(RID probe, double propagation)
- giProbeSetToCellXform
void giProbeSetToCellXform(RID probe, Transform xform)
- hasChanged
bool hasChanged()
Returns true if changes have been made to the VisualServer's data. draw is usually called if this happens.
- hasFeature
bool hasFeature(long feature)
- hasOsFeature
bool hasOsFeature(StringArg0 feature)
Returns true if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
- immediateBegin
void immediateBegin(RID immediate, long primitive, RID texture)
- immediateClear
void immediateClear(RID immediate)
- immediateColor
void immediateColor(RID immediate, Color color)
- immediateCreate
RID immediateCreate()
- immediateEnd
void immediateEnd(RID immediate)
- immediateGetMaterial
RID immediateGetMaterial(RID immediate)
- immediateNormal
void immediateNormal(RID immediate, Vector3 normal)
- immediateSetMaterial
void immediateSetMaterial(RID immediate, RID material)
- immediateTangent
void immediateTangent(RID immediate, Plane tangent)
- immediateUv
void immediateUv(RID immediate, Vector2 tex_uv)
- immediateUv2
void immediateUv2(RID immediate, Vector2 tex_uv)
- immediateVertex
void immediateVertex(RID immediate, Vector3 vertex)
- immediateVertex2d
void immediateVertex2d(RID immediate, Vector2 vertex)
- instanceAttachObjectInstanceId
void instanceAttachObjectInstanceId(RID instance, long id)
- instanceAttachSkeleton
void instanceAttachSkeleton(RID instance, RID skeleton)
- instanceCreate
RID instanceCreate()
- instanceCreate2
RID instanceCreate2(RID base, RID scenario)
- instanceGeometrySetAsInstanceLod
void instanceGeometrySetAsInstanceLod(RID instance, RID as_lod_of_instance)
- instanceGeometrySetCastShadowsSetting
void instanceGeometrySetCastShadowsSetting(RID instance, long shadow_casting_setting)
- instanceGeometrySetDrawRange
void instanceGeometrySetDrawRange(RID instance, double min, double max, double min_margin, double max_margin)
- instanceGeometrySetFlag
void instanceGeometrySetFlag(RID instance, long flag, bool enabled)
- instanceGeometrySetMaterialOverride
void instanceGeometrySetMaterialOverride(RID instance, RID material)
- instanceSetBase
void instanceSetBase(RID instance, RID base)
- instanceSetBlendShapeWeight
void instanceSetBlendShapeWeight(RID instance, long shape, double weight)
- instanceSetCustomAabb
void instanceSetCustomAabb(RID instance, AABB aabb)
- instanceSetExterior
void instanceSetExterior(RID instance, bool enabled)
- instanceSetExtraVisibilityMargin
void instanceSetExtraVisibilityMargin(RID instance, double margin)
- instanceSetLayerMask
void instanceSetLayerMask(RID instance, long mask)
- instanceSetScenario
void instanceSetScenario(RID instance, RID scenario)
- instanceSetSurfaceMaterial
void instanceSetSurfaceMaterial(RID instance, long surface, RID material)
- instanceSetTransform
void instanceSetTransform(RID instance, Transform transform)
- instanceSetUseLightmap
void instanceSetUseLightmap(RID instance, RID lightmap_instance, RID lightmap)
- instanceSetVisible
void instanceSetVisible(RID instance, bool visible)
- instancesCullAabb
Array instancesCullAabb(AABB aabb, RID scenario)
- instancesCullConvex
Array instancesCullConvex(Array convex, RID scenario)
- instancesCullRay
Array instancesCullRay(Vector3 from, Vector3 to, RID scenario)
- lightDirectionalSetBlendSplits
void lightDirectionalSetBlendSplits(RID light, bool enable)
- lightDirectionalSetShadowDepthRangeMode
void lightDirectionalSetShadowDepthRangeMode(RID light, long range_mode)
- lightDirectionalSetShadowMode
void lightDirectionalSetShadowMode(RID light, long mode)
- lightOmniSetShadowDetail
void lightOmniSetShadowDetail(RID light, long detail)
- lightOmniSetShadowMode
void lightOmniSetShadowMode(RID light, long mode)
- lightSetColor
void lightSetColor(RID light, Color color)
- lightSetCullMask
void lightSetCullMask(RID light, long mask)
- lightSetNegative
void lightSetNegative(RID light, bool enable)
- lightSetParam
void lightSetParam(RID light, long param, double value)
- lightSetProjector
void lightSetProjector(RID light, RID texture)
- lightSetReverseCullFaceMode
void lightSetReverseCullFaceMode(RID light, bool enabled)
- lightSetShadow
void lightSetShadow(RID light, bool enabled)
- lightSetShadowColor
void lightSetShadowColor(RID light, Color color)
- lightmapCaptureCreate
RID lightmapCaptureCreate()
- lightmapCaptureGetBounds
AABB lightmapCaptureGetBounds(RID capture)
- lightmapCaptureGetEnergy
double lightmapCaptureGetEnergy(RID capture)
- lightmapCaptureGetOctree
PoolByteArray lightmapCaptureGetOctree(RID capture)
- lightmapCaptureGetOctreeCellSubdiv
long lightmapCaptureGetOctreeCellSubdiv(RID capture)
- lightmapCaptureGetOctreeCellTransform
Transform lightmapCaptureGetOctreeCellTransform(RID capture)
- lightmapCaptureSetBounds
void lightmapCaptureSetBounds(RID capture, AABB bounds)
- lightmapCaptureSetEnergy
void lightmapCaptureSetEnergy(RID capture, double energy)
- lightmapCaptureSetOctree
void lightmapCaptureSetOctree(RID capture, PoolByteArray octree)
- lightmapCaptureSetOctreeCellSubdiv
void lightmapCaptureSetOctreeCellSubdiv(RID capture, long subdiv)
- lightmapCaptureSetOctreeCellTransform
void lightmapCaptureSetOctreeCellTransform(RID capture, Transform xform)
- makeSphereMesh
RID makeSphereMesh(long latitudes, long longitudes, double radius)
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
- materialCreate
RID materialCreate()
Returns an empty material.
- materialGetParam
Variant materialGetParam(RID material, StringArg1 parameter)
Returns the value of a certain material's parameter.
- materialGetParamDefault
Variant materialGetParamDefault(RID material, StringArg1 parameter)
- materialGetShader
RID materialGetShader(RID shader_material)
Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
- materialSetLineWidth
void materialSetLineWidth(RID material, double width)
Sets a materials line width.
- materialSetNextPass
void materialSetNextPass(RID material, RID next_material)
Sets an objects next material.
- materialSetParam
void materialSetParam(RID material, StringArg1 parameter, VariantArg2 value)
Sets a materials parameter.
- materialSetRenderPriority
void materialSetRenderPriority(RID material, long priority)
Sets a material's render priority.
- materialSetShader
void materialSetShader(RID shader_material, RID shader)
Sets a shader material's shader.
- meshAddSurfaceFromArrays
void meshAddSurfaceFromArrays(RID mesh, long primtive, Array arrays, Array blend_shapes, long compress_format)
Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE_* constants for types.
- meshClear
void meshClear(RID mesh)
Removes all surfaces from a mesh.
- meshCreate
RID meshCreate()
- meshGetBlendShapeCount
long meshGetBlendShapeCount(RID mesh)
Returns a mesh's blend shape count.
- meshGetBlendShapeMode
VisualServer.BlendShapeMode meshGetBlendShapeMode(RID mesh)
Returns a mesh's blend shape mode.
- meshGetCustomAabb
AABB meshGetCustomAabb(RID mesh)
Returns a mesh's custom aabb.
- meshGetSurfaceCount
long meshGetSurfaceCount(RID mesh)
Returns a mesh's number of surfaces.
- meshRemoveSurface
void meshRemoveSurface(RID mesh, long index)
Removes a mesh's surface.
- meshSetBlendShapeCount
void meshSetBlendShapeCount(RID mesh, long amount)
Sets a mesh's blend shape count.
- meshSetBlendShapeMode
void meshSetBlendShapeMode(RID mesh, long mode)
Sets a mesh's blend shape mode.
- meshSetCustomAabb
void meshSetCustomAabb(RID mesh, AABB aabb)
Sets a mesh's custom aabb.
- meshSurfaceGetAabb
AABB meshSurfaceGetAabb(RID mesh, long surface)
Returns a mesh's surface's aabb.
- meshSurfaceGetArray
PoolByteArray meshSurfaceGetArray(RID mesh, long surface)
Returns a mesh's surface's vertex buffer.
- meshSurfaceGetArrayIndexLen
long meshSurfaceGetArrayIndexLen(RID mesh, long surface)
Returns a mesh's surface's amount of indices.
- meshSurfaceGetArrayLen
long meshSurfaceGetArrayLen(RID mesh, long surface)
Returns a mesh's surface's amount of vertices.
- meshSurfaceGetArrays
Array meshSurfaceGetArrays(RID mesh, long surface)
Returns a mesh's surface's buffer arrays.
- meshSurfaceGetBlendShapeArrays
Array meshSurfaceGetBlendShapeArrays(RID mesh, long surface)
Returns a mesh's surface's arrays for blend shapes
- meshSurfaceGetFormat
long meshSurfaceGetFormat(RID mesh, long surface)
Returns the format of a mesh's surface.
- meshSurfaceGetFormatOffset
long meshSurfaceGetFormatOffset(long format, long vertex_len, long index_len, long array_index)
- meshSurfaceGetFormatStride
long meshSurfaceGetFormatStride(long format, long vertex_len, long index_len)
- meshSurfaceGetIndexArray
PoolByteArray meshSurfaceGetIndexArray(RID mesh, long surface)
Returns a mesh's surface's index buffer.
- meshSurfaceGetMaterial
RID meshSurfaceGetMaterial(RID mesh, long surface)
Returns a mesh's surface's material.
- meshSurfaceGetPrimitiveType
VisualServer.PrimitiveType meshSurfaceGetPrimitiveType(RID mesh, long surface)
Returns the primitive type of a mesh's surface.
- meshSurfaceGetSkeletonAabb
Array meshSurfaceGetSkeletonAabb(RID mesh, long surface)
Returns the aabb of a mesh's surface's skeleton.
- meshSurfaceSetMaterial
void meshSurfaceSetMaterial(RID mesh, long surface, RID material)
Sets a mesh's surface's material.
- meshSurfaceUpdateRegion
void meshSurfaceUpdateRegion(RID mesh, long surface, long offset, PoolByteArray data)
- multimeshAllocate
void multimeshAllocate(RID multimesh, long instances, long transform_format, long color_format, long custom_data_format)
- multimeshGetAabb
AABB multimeshGetAabb(RID multimesh)
- multimeshGetInstanceCount
long multimeshGetInstanceCount(RID multimesh)
- multimeshGetMesh
RID multimeshGetMesh(RID multimesh)
- multimeshGetVisibleInstances
long multimeshGetVisibleInstances(RID multimesh)
- multimeshInstanceGetColor
Color multimeshInstanceGetColor(RID multimesh, long index)
- multimeshInstanceGetCustomData
Color multimeshInstanceGetCustomData(RID multimesh, long index)
- multimeshInstanceGetTransform
Transform multimeshInstanceGetTransform(RID multimesh, long index)
- multimeshInstanceGetTransform2d
Transform2D multimeshInstanceGetTransform2d(RID multimesh, long index)
- multimeshInstanceSetColor
void multimeshInstanceSetColor(RID multimesh, long index, Color color)
- multimeshInstanceSetCustomData
void multimeshInstanceSetCustomData(RID multimesh, long index, Color custom_data)
- multimeshInstanceSetTransform
void multimeshInstanceSetTransform(RID multimesh, long index, Transform transform)
- multimeshInstanceSetTransform2d
void multimeshInstanceSetTransform2d(RID multimesh, long index, Transform2D transform)
- multimeshSetAsBulkArray
void multimeshSetAsBulkArray(RID multimesh, PoolRealArray array)
- multimeshSetMesh
void multimeshSetMesh(RID multimesh, RID mesh)
- multimeshSetVisibleInstances
void multimeshSetVisibleInstances(RID multimesh, long visible)
- omniLightCreate
RID omniLightCreate()
- opAssign
VisualServerSingleton opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
- opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
- opEquals
bool opEquals(VisualServerSingleton other)
Undocumented in source. Be warned that the author may not have intended to support it.
- particlesCreate
RID particlesCreate()
- particlesGetCurrentAabb
AABB particlesGetCurrentAabb(RID particles)
- particlesGetEmitting
bool particlesGetEmitting(RID particles)
- particlesRestart
void particlesRestart(RID particles)
- particlesSetAmount
void particlesSetAmount(RID particles, long amount)
- particlesSetCustomAabb
void particlesSetCustomAabb(RID particles, AABB aabb)
- particlesSetDrawOrder
void particlesSetDrawOrder(RID particles, long order)
- particlesSetDrawPassMesh
void particlesSetDrawPassMesh(RID particles, long pass, RID mesh)
- particlesSetDrawPasses
void particlesSetDrawPasses(RID particles, long count)
- particlesSetEmissionTransform
void particlesSetEmissionTransform(RID particles, Transform transform)
- particlesSetEmitting
void particlesSetEmitting(RID particles, bool emitting)
- particlesSetExplosivenessRatio
void particlesSetExplosivenessRatio(RID particles, double ratio)
- particlesSetFixedFps
void particlesSetFixedFps(RID particles, long fps)
- particlesSetFractionalDelta
void particlesSetFractionalDelta(RID particles, bool enable)
- particlesSetLifetime
void particlesSetLifetime(RID particles, double lifetime)
- particlesSetOneShot
void particlesSetOneShot(RID particles, bool one_shot)
- particlesSetPreProcessTime
void particlesSetPreProcessTime(RID particles, double time)
- particlesSetProcessMaterial
void particlesSetProcessMaterial(RID particles, RID material)
- particlesSetRandomnessRatio
void particlesSetRandomnessRatio(RID particles, double ratio)
- particlesSetSpeedScale
void particlesSetSpeedScale(RID particles, double scale)
- particlesSetUseLocalCoordinates
void particlesSetUseLocalCoordinates(RID particles, bool enable)
- reflectionProbeCreate
RID reflectionProbeCreate()
- reflectionProbeSetAsInterior
void reflectionProbeSetAsInterior(RID probe, bool enable)
- reflectionProbeSetCullMask
void reflectionProbeSetCullMask(RID probe, long layers)
- reflectionProbeSetEnableBoxProjection
void reflectionProbeSetEnableBoxProjection(RID probe, bool enable)
- reflectionProbeSetEnableShadows
void reflectionProbeSetEnableShadows(RID probe, bool enable)
- reflectionProbeSetExtents
void reflectionProbeSetExtents(RID probe, Vector3 extents)
- reflectionProbeSetIntensity
void reflectionProbeSetIntensity(RID probe, double intensity)
- reflectionProbeSetInteriorAmbient
void reflectionProbeSetInteriorAmbient(RID probe, Color color)
- reflectionProbeSetInteriorAmbientEnergy
void reflectionProbeSetInteriorAmbientEnergy(RID probe, double energy)
- reflectionProbeSetInteriorAmbientProbeContribution
void reflectionProbeSetInteriorAmbientProbeContribution(RID probe, double contrib)
- reflectionProbeSetMaxDistance
void reflectionProbeSetMaxDistance(RID probe, double distance)
- reflectionProbeSetOriginOffset
void reflectionProbeSetOriginOffset(RID probe, Vector3 offset)
- reflectionProbeSetUpdateMode
void reflectionProbeSetUpdateMode(RID probe, long mode)
- requestFrameDrawnCallback
void requestFrameDrawnCallback(GodotObject where, StringArg1 method, VariantArg2 userdata)
Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn.
The callback method must use only 1 argument which will be called with 'userdata'.
- scenarioCreate
RID scenarioCreate()
- scenarioSetDebug
void scenarioSetDebug(RID scenario, long debug_mode)
- scenarioSetEnvironment
void scenarioSetEnvironment(RID scenario, RID environment)
- scenarioSetFallbackEnvironment
void scenarioSetFallbackEnvironment(RID scenario, RID environment)
- scenarioSetReflectionAtlasSize
void scenarioSetReflectionAtlasSize(RID scenario, long p_size, long subdiv)
- setBootImage
void setBootImage(Image image, Color color, bool scale)
Sets a boot image. The color defines the background color and if scale is true the image will be scaled to fit the screen size.
- setDebugGenerateWireframes
void setDebugGenerateWireframes(bool generate)
- setDefaultClearColor
void setDefaultClearColor(Color color)
- shaderCreate
RID shaderCreate()
- shaderGetCode
String shaderGetCode(RID shader)
- shaderGetDefaultTextureParam
RID shaderGetDefaultTextureParam(RID shader, StringArg1 name)
Returns a default texture from a shader searched by name.
- shaderGetParamList
Array shaderGetParamList(RID shader)
Returns the parameters of a shader.
- shaderSetCode
void shaderSetCode(RID shader, StringArg1 code)
- shaderSetDefaultTextureParam
void shaderSetDefaultTextureParam(RID shader, StringArg1 name, RID texture)
Sets a shader's default texture. Overwrites the texture given by name.
- skeletonAllocate
void skeletonAllocate(RID skeleton, long bones, bool is_2d_skeleton)
- skeletonBoneGetTransform
Transform skeletonBoneGetTransform(RID skeleton, long bone)
- skeletonBoneGetTransform2d
Transform2D skeletonBoneGetTransform2d(RID skeleton, long bone)
- skeletonBoneSetTransform
void skeletonBoneSetTransform(RID skeleton, long bone, Transform transform)
- skeletonBoneSetTransform2d
void skeletonBoneSetTransform2d(RID skeleton, long bone, Transform2D transform)
- skeletonCreate
RID skeletonCreate()
- skeletonGetBoneCount
long skeletonGetBoneCount(RID skeleton)
- skyCreate
RID skyCreate()
- skySetTexture
void skySetTexture(RID sky, RID cube_map, long radiance_size)
- spotLightCreate
RID spotLightCreate()
- sync
void sync()
- textureAllocate
void textureAllocate(RID texture, long width, long height, long depth_3d, long format, long type, long flags)
- textureCreate
RID textureCreate()
Creates an empty texture.
- textureCreateFromImage
RID textureCreateFromImage(Image image, long flags)
Creates a texture, allocates the space for an image, and fills in the image.
- textureDebugUsage
Array textureDebugUsage()
Returns a list of all the textures and their information.
- textureGetData
Ref!Image textureGetData(RID texture, long cube_side)
Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the RID of the image at one of the cubes sides.
- textureGetDepth
long textureGetDepth(RID texture)
- textureGetFlags
long textureGetFlags(RID texture)
Returns the flags of a texture.
- textureGetFormat
Image.Format textureGetFormat(RID texture)
Returns the format of the texture's image.
- textureGetHeight
long textureGetHeight(RID texture)
Returns the texture's height.
- textureGetPath
String textureGetPath(RID texture)
Returns the texture's path.
- textureGetTexid
long textureGetTexid(RID texture)
Returns the opengl id of the texture's image.
- textureGetType
VisualServer.TextureType textureGetType(RID texture)
- textureGetWidth
long textureGetWidth(RID texture)
Returns the texture's width.
- textureSetData
void textureSetData(RID texture, Image image, long layer)
Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.
- textureSetDataPartial
void textureSetDataPartial(RID texture, Image image, long src_x, long src_y, long src_w, long src_h, long dst_x, long dst_y, long dst_mip, long layer)
- textureSetFlags
void textureSetFlags(RID texture, long flags)
Sets the texture's flags. See textureflags for options
- textureSetPath
void textureSetPath(RID texture, StringArg1 path)
- textureSetShrinkAllX2OnSetData
void textureSetShrinkAllX2OnSetData(bool shrink)
If true sets internal processes to shrink all image data to half the size.
- textureSetSizeOverride
void textureSetSizeOverride(RID texture, long width, long height, long depth)
- texturesKeepOriginal
void texturesKeepOriginal(bool enable)
If true the image will be stored in the texture's images array if overwritten.
- viewportAttachCamera
void viewportAttachCamera(RID viewport, RID camera)
Sets a viewport's camera.
- viewportAttachCanvas
void viewportAttachCanvas(RID viewport, RID canvas)
Sets a viewport's canvas.
- viewportAttachToScreen
void viewportAttachToScreen(RID viewport, Rect2 rect, long screen)
Attaches a viewport to a screen.
- viewportCreate
RID viewportCreate()
Creates an empty viewport.
- viewportDetach
void viewportDetach(RID viewport)
Detaches the viewport from the screen.
- viewportGetRenderInfo
long viewportGetRenderInfo(RID viewport, long info)
Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO* constants.
- viewportGetTexture
RID viewportGetTexture(RID viewport)
Returns the viewport's last rendered frame.
- viewportRemoveCanvas
void viewportRemoveCanvas(RID viewport, RID canvas)
Detaches a viewport from a canvas and vice versa.
- viewportSetActive
void viewportSetActive(RID viewport, bool active)
If true sets the viewport active, else sets it inactive.
- viewportSetCanvasLayer
void viewportSetCanvasLayer(RID viewport, RID canvas, long layer)
- viewportSetCanvasTransform
void viewportSetCanvasTransform(RID viewport, RID canvas, Transform2D offset)
Sets the transformation of a viewport's canvas.
- viewportSetClearMode
void viewportSetClearMode(RID viewport, long clear_mode)
Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE_* constants for options.
- viewportSetDebugDraw
void viewportSetDebugDraw(RID viewport, long draw)
Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW_* constants for options.
- viewportSetDisable3d
void viewportSetDisable3d(RID viewport, bool disabled)
If true a viewport's 3D rendering is disabled.
- viewportSetDisableEnvironment
void viewportSetDisableEnvironment(RID viewport, bool disabled)
If true rendering of a viewport's environment is disabled.
- viewportSetGlobalCanvasTransform
void viewportSetGlobalCanvasTransform(RID viewport, Transform2D transform)
Sets the viewport's global transformation matrix.
- viewportSetHdr
void viewportSetHdr(RID viewport, bool enabled)
If true the viewport renders to hdr.
- viewportSetHideCanvas
void viewportSetHideCanvas(RID viewport, bool hidden)
If true the viewport's canvas is not rendered.
- viewportSetHideScenario
void viewportSetHideScenario(RID viewport, bool hidden)
- viewportSetMsaa
void viewportSetMsaa(RID viewport, long msaa)
Sets the anti-aliasing mode. see viewportmsaa for options.
- viewportSetParentViewport
void viewportSetParentViewport(RID viewport, RID parent_viewport)
Sets the viewport's parent to another viewport.
- viewportSetScenario
void viewportSetScenario(RID viewport, RID scenario)
Sets a viewport's scenario.
The scenario contains information about the scenariodebugmode, environment information, reflection atlas etc.
- viewportSetShadowAtlasQuadrantSubdivision
void viewportSetShadowAtlasQuadrantSubdivision(RID viewport, long quadrant, long subdivision)
Sets the shadow atlas quadrant's subdivision.
- viewportSetShadowAtlasSize
void viewportSetShadowAtlasSize(RID viewport, long size)
Sets the size of the shadow atlas's images.
- viewportSetSize
void viewportSetSize(RID viewport, long width, long height)
Sets the viewport's width and height.
- viewportSetTransparentBackground
void viewportSetTransparentBackground(RID viewport, bool enabled)
If true the viewport renders its background as transparent.
- viewportSetUpdateMode
void viewportSetUpdateMode(RID viewport, long update_mode)
Sets when the viewport should be updated. See viewportupdatemode constants for options.
- viewportSetUsage
void viewportSetUsage(RID viewport, long usage)
Sets the viewport's 2D/3D mode. See viewportusage constants for options.
- viewportSetUseArvr
void viewportSetUseArvr(RID viewport, bool use_arvr)
If true the viewport uses augmented or virtual reality technologies. See ARVRInterface.
- viewportSetVflip
void viewportSetVflip(RID viewport, bool enabled)
If true the viewport's rendering is flipped vertically.
Server for anything visible.
The visual server is the API backend for everything visible. The whole scene system mounts on it to display. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.