Home > @gglib/graphics

graphics package

Classes

Class Description
AnimationChannelIndexer
AnimationChannelSampler
AnimationChannelsSampler
AnimationPlayer
BlendState
BlendStateGL
BlendStateGPU
Buffer
BufferGL
BufferGPU
Capabilities
Color
CullState
CullStateGL
CullStateGPU
DepthBuffer Describes a depth buffer object
DepthBufferGL Describes a depth buffer object
DepthBufferGPU Describes a depth buffer object
DepthState
DepthStateGL
DepthStateGPU
Device Describes the Graphics Device
DeviceGL Describes the Graphics Device
DeviceGPU Describes the Graphics Device
FrameBuffer
FrameBufferGL
FrameBufferGPU
Material Defines a parameter set for a specific ShaderEffect
Model
ModelBuilder A helper class for building 3d geometries
ModelBuilderChannel
ModelMesh
ModelMeshPart
ModelMeshPartUtil
ModelPose
OffsetState
OffsetStateGL
OffsetStateGPU
PrimitiveBatch
SamplerState
SamplerStateGL
SamplerStateGPU
ScissorState
ScissorStateGL
ScissorStateGPU
Shader A wrapper class around the WebGLShader
ShaderEffect Defines a collection of ShaderTechniques.
ShaderGL A wrapper class around the WebGLShader
ShaderGPU
ShaderInspector
ShaderPass Defines Device states which should be used with a specific ShaderProgram
ShaderProgram A wrapper class around WebGLProgram
ShaderProgramGL A wrapper class around WebGLProgram
ShaderProgramGPU
ShaderTechnique Defines a sequence of ShaderPasses
ShaderUniform
ShaderUniformGL
Sprite
SpriteBatch
StencilState
StencilStateGL
StencilStateGPU
Texture Describes a texture object.
TextureGL Describes a texture object.
TextureGPU Describes a texture object.
TextureSource
TextureSourceData
TextureSourceImage
TextureSourceVideo
TextureUnitState
TextureUnitStateGL
VertexAttribArrayState
VertexLayout Provides vertex layout utility functions
ViewportState
ViewportStateGL
ViewportStateGPU

Enumerations

Enumeration Description
Blend
BlendFunction
BufferType
BufferUsage
CompareFunction
CullMode
DataType
DepthFormat
FrontFace
GLConst
LightType
PixelFormat
PrimitiveType
ShaderType
StencilFormat
StencilOperation
SurfaceFormat
TextureFilter
TextureType
TextureWrapMode

Functions

Function Description
assembleProgram(base, chunks, defines) Combines a set of shader chunks into vertexShader and fragmentShader source files
assembleShader(base, chunks, defines) Combines a set of shader chunks into a single shader source file
buildBezierSurface(builder, patch, tesselation, basis) Builds a bezier surface into the ModelBuilder
buildCap(builder, options) Builds a cap shape into the ModelBuilder
buildCone(builder, options) Builds a cone shape into the ModelBuilder
buildCube(builder, options) Builds a cube shape into the ModelBuilder
buildCylinder(builder, options) Builds a cylinder shape into the ModelBuilder
buildDisc(builder, options) Builds a disc shape into the ModelBuilder
buildIcosahedron(builder, options) Builds an icosahedron shape into the ModelBuilder
buildLines(builder, vertexBuffer) Builds lines to display vertex normal tangent and bitangent vectors
buildMobiusStrip(builder, options) Builds a mobius strip shape into the ModelBuilder
buildOctahedron(builder, options) Builds an octahedron shape into the ModelBuilder
buildParametricSurface(builder, options) Builds a parametric surface into the ModelBuilder
buildPlane(builder, options) Builds a plane shape into the ModelBuilder
buildSphere(builder, options) Builds a sphere shape into the ModelBuilder
buildSphericalHarmonics(builder, options) Builds a spherical harmonics shape into the ModelBuilder
buildSuperEllipsoid(builder, options) Builds a super ellipsoid shape into the ModelBuilder
buildTetrahedron(builder, options) Builds an tetrahedron shape into the ModelBuilder
buildTorus(builder, options) Builds a torus shape into the ModelBuilder
calculateNormals(indices, channels, vCount, frontFace) Recalculates the normals for each vertex
calculateTangents(indices, channels, vCount, frontFace) Recalculates the tangents for each vertex
commonVertexAttribute(semantic, overrides) Gets a vertex attribute specification for given attribute semantic
createDevice(options)
createShaderEffect(device, doc, includeHandler)
createShaderEffectOptions(doc, includeHandler)
createShaderEffectOptionsSync(doc, includeHandler)
createShaderEffectSync(device, doc, includeHandler)
dataTypeSize(value)
flipUV(layout, vertices)
flipWindingOrder(indices) Flips the winding order of given indices
glsl(str) A template string function for glsl source code
nameOfBlend(keyOrValue)
nameOfBlendFunction(keyOrValue)
nameOfBufferType(keyOrValue)
nameOfBufferUsage(keyOrValue)
nameOfCompareFunction(keyOrValue)
nameOfCullMode(keyOrValue)
nameOfDataType(keyOrValue)
nameOfDepthFormat(keyOrValue)
nameOfFrontFace(keyOrValue)
nameOfLightType(keyOrValue)
nameOfPixelFormat(keyOrValue)
nameOfPrimitiveType(keyOrValue)
nameOfShaderType(keyOrValue)
nameOfStencilFormat(keyOrValue)
nameOfStencilOperation(keyOrValue)
nameOfSurfaceFormat(keyOrValue)
nameOfTextureFilter(keyOrValue)
nameOfTextureType(keyOrValue)
nameOfTextureWrapMode(keyOrValue)
pixelFormatElementCount(value)
valueOfBlend(keyOrValue)
valueOfBlendFunction(keyOrValue)
valueOfBufferType(keyOrValue)
valueOfBufferUsage(keyOrValue)
valueOfCompareFunction(keyOrValue)
valueOfCullMode(keyOrValue)
valueOfDataType(keyOrValue)
valueOfDepthFormat(keyOrValue)
valueOfFrontFace(keyOrValue)
valueOfLightType(keyOrValue)
valueOfPixelFormat(keyOrValue)
valueOfPrimitiveType(keyOrValue)
valueOfShaderType(keyOrValue)
valueOfStencilFormat(keyOrValue)
valueOfStencilOperation(keyOrValue)
valueOfSurfaceFormat(keyOrValue)
valueOfTextureFilter(keyOrValue)
valueOfTextureType(keyOrValue)
valueOfTextureWrapMode(keyOrValue)

Interfaces

Interface Description
AnimationData
AnimationDataChannel
AnimationDataChannels
AnimationDataChannelSample
AnimationDataFrame
AnimationDataSample
AnimationTargetPose
BlendStateOptions Options to be converted into IBlendState via BlendState.convert()
BufferOptions Constructor options for Buffer
BuildConeOptions Options for the buildCone() function
BuildCubeOptions Options for the buildCube() function
BuildCylinderOptions Options for the buildCylinder() function
BuildDiscOptions Options for the buildDisc() function
BuildMobiusStripOptions Options for the buildMobiusStrip() function
BuildParametricSurfaceOptions Options for the buildParametricSurface() function
BuildPlaneOptions Options for the buildPlane() function
BuildSphereOptions Options for the buildSphere() function
BuildTorusOptions Options for the buildTorus() function
CullStateOptions Options to be converted into ICullState via CullState.convert()
DepthBufferOptions Options to be used to create a new DepthBuffer
DepthStateOptions Options to be converted into IDepthState via DepthState.convert()
DeviceGLOptions Constructor options for the Device
DeviceGPUOptions Constructor options for the Device
FrameBufferOptions
IAnimationClip
IBlendState An object with all blend state parameters
ICullState An object with all cull state parameters
IDepthState An object with all depth state parameters
IOffsetState An object with all offset state parameters
ISamplerState An object with all sampler state properties
IScissorState An object with all scissor state parameters
IStencilState An object with all depth state parameters
IViewPortState An object with all viewport state parameters
MaterialOptions Constructor options for Material
ModelBuilderChannelMap
ModelBuilderOptions Constructor options for ModelBuilder
ModelMeshOptions
ModelMeshPartOptions Constructor options for ModelMeshPart
ModelNode
ModelNodePose
ModelOptions
ModelSkin
PrimitiveBatchBeginOptions Options for SpriteBatch.begin()
PrimitiveBatchOptions Constructor options for SpriteBatch
ProgramInspection
RenderTargetOptions
ShaderChunkSet A map of shader code snippets
ShaderDefines A map of #define statements for a shader
ShaderEffectOptions Constructor options for ShaderEffect
ShaderEffectParameters
ShaderFxDocument
ShaderFxPass
ShaderFxTechnique
ShaderInspection
ShaderObjectInfo
ShaderOptions Constructor options for Shader
ShaderPassOptions Constructor options for ShaderPass
ShaderProgramOptions Constructor options for ShaderProgram
ShaderTechniqueOptions Constructor options for ShaderTechnique
ShaderUniformBinding
ShaderUniformOptions Constructor options for ShaderUniform
SpriteBatchBeginOptions Options for SpriteBatch.begin()
SpriteBatchOptions Constructor options for SpriteBatch
StencilStateOptions Options to be converted into IStencilState via StencilState.convert()
TextureLike An object with a reference to a webgl texture
TextureOptions Constructor options for Texture
VertexAttribute Describes an attribute of a vertex

Variables

Variable Description
ABGR_FORMAT ABGR formatted color parser
ArrayType
DefaultContextAttributes
RGBA_FORMAT RGBA formatted color parser
supportsWebGL Determines whether webgl is supported
supportsWebGL2 Determines whether webgl 2.0 is supported
VertexLayoutCommons Provides layouts of common attributes like position, color, texture etc.

Type Aliases

Type Alias Description
BlendFunctionName
BlendFunctionOption
BlendName
BlendOption
BlendStateParams Represents a sub set of IBlendState
BufferDataOption Data type that is accepted by the setData* methods
BufferTypeName
BufferTypeOption
BufferUsageName
BufferUsageOption
CompareFunctionName
CompareFunctionOption
CullModeName
CullModeOption
CullStateParams An object with all cull state parameters
DataTypeName
DataTypeOption
DepthFormatName
DepthFormatOption
DepthStateParams Represents a sub set of IDepthState
FrontFaceName
FrontFaceOption
LightTypeName
LightTypeOption
MaterialParameters
ModelBuilderFunction A function that adds geometry into a given ModelBuilder
OffsetStateParams Represents a sub set of IOffsetState
PixelFormatName
PixelFormatOption
PrimitiveTypeName
PrimitiveTypeOption
SamplerStateParams An object with partial ISamplerState properties
ScissorStateParams Represents a sub set of IScissorState
ShaderChunk A shader code snippet
ShaderFxIncludeHandler
ShaderFxIncludeSyncHandler
ShaderTypeName
ShaderTypeOption
ShaderUniformValue A union type combining all types that are supported by the ShaderUniform
StencilFormatName
StencilFormatOption
StencilOperationName
StencilOperationOption
StencilStateParams Represents a sub set of IStencilState
SurfaceFormatName
SurfaceFormatOption
TextureDataOption Type that is accepted by the Texture.setData() method
TextureFilterName
TextureFilterOption
TextureSourceOption
TextureTypeName
TextureTypeOption
TextureWrapModeName
TextureWrapModeOption
ViewportStateParams Represents a sub set of IViewPortState