API Docs for: 0.5.5
Show:

kick.core.BuiltInResourceProvider Class

Responsible for providing the built-in resources (such as textures, shaders and mesh data). All build-in resources have the prefix kickjs

Constructor

kick.core.BuiltInResourceProvider

(
  • engine
)
private

Parameters:

Item Index

Properties

Methods

getImageData

(
  • uri
  • textureDestination
)

Create a default texture based on a URL.
The following default textures exists:

  • Black Url: kickjs://texture/black/
  • White Url: kickjs://texture/white/
  • Gray Url: kickjs://texture/gray/
  • Default normal Url: kickjs://texture/default_normal/
  • Checkerboard Url: kickjs://texture/checkerboard/
  • KickJS logo Url: kickjs://texture/logo/

Parameters:

  • uri Object
  • textureDestination Object

getMeshData

(
  • url
  • meshDestination
  • [resourceTracker]
)
  • Triangle Url: kickjs://mesh/triangle/
  • Plane Url: kickjs://mesh/plane/
  • Disc Url: kickjs://mesh/disc/?slides=20
  • UVSphere Url: kickjs://mesh/uvsphere/?slides=20&stacks=10&radius=1.0
    Note that the parameters is optional
  • Cube Url: kickjs://mesh/cube/?length=1.0
    Note that the parameters is optional
  • Point Url: kickjs://mesh/point/

Parameters:

  • url String
  • meshDestination kick.mesh.Mesh
  • [resourceTracker] ResourceTracker optional

getShaderData

(
  • url
  • shaderDestination
)

Create a default shader config based on a URL
The following shaders are available:

  • Default Url: kickjs://shader/default/
  • Specular Url: kickjs://shader/specular/
  • Diffuse Url: kickjs://shader/diffuse/
  • Unlit Url: kickjs://shader/unlit/
  • Unlitno_depth Url: kickjs://shader/unlit_no_depth/
  • Bumped Specular Url: kickjs://shader/bumped_specular/
  • Transparent Point Unlit Url: kickjs://shader/point_transparent_unlit/
  • Transparent Specular Url: kickjs://shader/transparent_specular/
  • Transparent Unlit Url: kickjs://shader/transparent_unlit/
  • Particles Url: kickjs://shader/particles/
  • Skybox Url: kickjs://shader/skybox/
  • Shadowmap Url: kickjs://shader/\_shadowmap/
  • Pick Url: kickjs://shader/__pick/
  • Error Url: kickjs://shader/__error/

Parameters:

Properties

protocol

String final

Returns kickjs