Package com.google.android.filament
See: Description
-
Annotation Summary Annotation Description EntityInstance LinearColor Entity -
Enum Summary Enum Description RgbType Types of RGB colors. RgbaType Types of RGBA colors. Conversion Type of color conversion to use when converting to/from sRGB and linear spaces. Sampler Type of sampler InternalFormat Internal texel formatsThese formats are used to specify a texture's internal storage format. CompressedFormat Compressed data types for use with PixelBufferDescriptor CubemapFace Cubemap faces Format Pixel color format Type Pixel data type Swizzle Texture swizzling channels Shading Supported shading models Interpolation Attribute interpolation types in the fragment shader BlendingMode Supported blending modes RefractionMode Supported refraction modes RefractionType Supported refraction types VertexDomain Supported types of vertex domains CullingMode Face culling Mode Type Precision BooleanElement IntElement FloatElement StencilOperation Operations that control how the stencil buffer is updated. StencilFace Type Denotes the type of the light being created. BindingType Mode FenceStatus QualityLevel Color grading quality level. LutFormat Color grading LUT format. ToneMapping List of available tone-mapping operators. StreamType Represents the immutable stream type. IndexType Type of the index buffer. Backend Denotes a backend FeatureLevel Defines the backend's feature levels. PrimitiveType Primitive types used in geometry. ToneMapping List of available tone-mapping operators TargetBufferFlags Used to select buffers. AmbientOcclusion List of available ambient occlusion techniques. QualityLevel Generic quality level. BlendMode BlendMode Filter AntiAliasing List of available post-processing anti-aliasing techniques. Dithering List of available post-processing dithering techniques. ShadowType List of available shadow mapping techniques. WrapMode MinFilter MagFilter CompareMode CompareFunction Comparison functions for the depth sampler. Projection Denotes the projection type used by this camera. Fov Denotes a field-of-view direction. VertexAttribute AttributeType AttachmentPoint An attachment point is a slot that can be assigned to a Texture. -
Class Summary Class Description Colors Utilities to manipulate and convert colors. PixelBufferDescriptor A descriptor to an image in main memory, typically used to transfer image data from the CPUto the GPU. PrefilterOptions Options of generatePrefilterMipmap Builder Use Builderto construct aTextureobject instance.Usage A bitmask to specify how the texture will be used. Texture Texture The Textureclass supports:- 2D textures
- 3D textures
- Cube maps
- mip mapping
Textureobject is created using the Texture.Builder and destroyed by calling destroyTexture.Parameter Builder Material A Filament Material defines the visual appearance of an object. Builder Constructs an immutable surface orientation helper.At a minimum, clients must supply a vertex count. SurfaceOrientation Helper used to populate TANGENTSbuffers.MaterialInstance ShadowOptions Control the quality / performance of the shadow map associated to this light ShadowCascades Builder Use Builder to construct a Light object instance LightManager LightManager allows you to create a light source in the scene, such as a sun or street lights. Builder BufferObject A generic GPU buffer containing data. Builder SkinningBuffer Builder Use Builderto construct anIndirectLightobject instance.IndirectLight IndirectLightis used to simulate environment lighting, a form of global illumination.Fence MathUtils Builder Use Builderto construct aColorGradingobject instance.ColorGrading ColorGradingis used to transform (either to modify or correct) the colors of the HDR buffer rendered by Filament.Builder MorphTargetBuffer Scene A Sceneis a flat container of RenderableManager and LightManager components.NativeSurface Builder Use Builderto construct an Stream object instance.Stream Streamis used to attach a native video stream to a filament Texture.Builder IndexBuffer A buffer containing vertex indices into a VertexBuffer.SwapChain A SwapChainrepresents an Operating System's native renderable surface.Engine Engine is filament's main entry-point. Builder Adds renderable components to entities using a builder pattern. RenderableManager Factory and manager for renderables, which are entities that can be drawn. PickingQueryResult A class containing the result of a picking query DynamicResolutionOptions Dynamic resolution can be used to either reach a desired target frame rateby lowering the resolution of a View, or to increase the quality when therendering is faster than the target frame rate.This structure can be used to specify the minimum scale factor used whenlowering the resolution of a View, and the maximum scale factor used whenincreasing the resolution for higher quality rendering. BloomOptions Options to control the bloom effectenabled: Enable or disable the bloom post-processing effect. FogOptions Options to control large-scale fog in the scene DepthOfFieldOptions Options to control Depth of Field (DoF) effect in the scene.cocScale can be used to set the depth of field blur independently from the cameraaperture, e.g. VignetteOptions Options to control the vignetting effect. RenderQuality Structure used to set the precision of the color buffer and related quality settings. AmbientOcclusionOptions Options for screen space Ambient Occlusion (SSAO) and Screen Space Cone Tracing (SSCT) MultiSampleAntiAliasingOptions Options for Temporal Multi-Sample Anti-aliasing (MSAA) TemporalAntiAliasingOptions Options for Temporal Anti-aliasing (TAA) ScreenSpaceReflectionsOptions Options for Screen-space Reflections. GuardBandOptions Options for the screen-space guard band.A guard band can be enabled to avoid some artifacts towards the edge of the screen whenusing screen-space effects such as SSAO. VsmShadowOptions View-level options for VSM Shadowing. SoftShadowOptions View-level options for DPCF and PCSS Shadowing. View Encompasses all the state needed for rendering a Scene. DisplayInfo Information about the display this renderer is associated to FrameRateOptions Use FrameRateOptions to set the desired frame rate and control how quickly the systemreacts to GPU load changes.interval: desired frame interval in multiple of the refresh period, set in DisplayInfo(as 1 / DisplayInfo.refreshRate)The parameters below are relevant when some Views are using dynamic resolution scaling:headRoomRatio: additional headroom for the GPU as a ratio of the targetFrameTime.Useful for taking into account constant costs like post-processing orGPU drivers on different platforms.history: History size. ClearOptions ClearOptions are used at the beginning of a frame to clear or retain the SwapChain content. Renderer A Rendererinstance represents an operating system's window.Viewport Specifies a rectangular region within a render target in terms of pixel coordinates. TextureSampler TextureSamplerdefines how a texture is accessed.Filament TransformManager TransformManageris used to add transform components to entities.Linear Linear tone mapping operator that returns the input color but clamped tothe 0..1 range. ACES ACES tone mapping operator. ACESLegacy ACES tone mapping operator, modified to match the perceived brightnessof FilmicToneMapper. Filmic "Filmic" tone mapping operator. Generic Generic tone mapping operator that gives control over the tone mappingcurve. ToneMapper Interface for tone mapping operators. Box An axis-aligned 3D box represented by its center and half-extent. Camera Camera represents the eye through which the scene is viewed. Builder VertexBuffer Holds a set of buffers that define the geometry of a Renderable.Builder Constructs RenderTargetobjects using a builder pattern.RenderTarget An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects. Builder Use Builderto construct aSkyboxobject instance.Skybox Skybox When added to a Scene, the Skyboxfills all untouched pixels.EntityManager BuildConfig -
Interface Summary Interface Description OnPickCallback An interface to implement a custom class to receive results of picking queries.