VertexFormat - Cesium Documentation

VertexFormat

new VertexFormat

A vertex format defines what attributes make up a vertex. A VertexFormat can be provided to a Geometry to request that certain properties be computed, e.g., just position, position and normal, etc.

Parameters:

Name	Type	Argument	Default	Description
`options`	Object	<optional>	undefined	An object with boolean properties corresponding to VertexFormat properties as shown in the code example.

Example

// Create a vertex format with position and 2D texture coordinate attributes.
var format = new VertexFormat({
  position : true,
  st : true
});

See:

Geometry#attributes

Source:

/Source/Core/VertexFormat.js

Members

binormal :Boolean

When true, the vertex has a binormal attribute (normalized), which is used for tangent-space effects like bump mapping.

32-bit floating-point. 3 components per attribute.

Default Value:

false

normal :Boolean

When true, the vertex has a normal attribute (normalized), which is commonly used for lighting.

32-bit floating-point. 3 components per attribute.

Default Value:

false

position :Boolean

When true, the vertex has a 3D position attribute.

64-bit floating-point (for precision). 3 components per attribute.

Default Value:

false

st :Boolean

When true, the vertex has a 2D texture coordinate attribute.

32-bit floating-point. 2 components per attribute

Default Value:

false

tangent :Boolean

When true, the vertex has a tangent attribute (normalized), which is used for tangent-space effects like bump mapping.

32-bit floating-point. 3 components per attribute.

Default Value:

false

<static> ALL

An immutable vertex format with all well-known attributes: position, normal, st, binormal, and tangent.

See:

<static> DEFAULT

An immutable vertex format with position, normal, and st attributes. This is compatible with most appearances and materials; however normal and st attributes are not always required. When this is known in advance, another VertexFormat should be used.

See:

<static> POSITION_AND_NORMAL

An immutable vertex format with position and normal attributes. This is compatible with per-instance color appearances like PerInstanceColorAppearance.

See:

<static> POSITION_AND_ST

An immutable vertex format with position and st attributes. This is compatible with EllipsoidSurfaceAppearance.

See:

<static> POSITION_NORMAL_AND_ST

An immutable vertex format with position, normal, and st attributes. This is compatible with MaterialAppearance when MaterialAppearance#materialSupport is

TEXTURED/code>.


    
        
    
	
	

    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
    
	
     
	
	
	See:
	
		VertexFormat#position
	
		VertexFormat#normal
	
		VertexFormat#st



        
            

    <static> POSITION_ONLY
    
    


    
    
        An immutable vertex format with only a position attribute.
    
    
        
    
	
	

    
        
	
	
	
	
	
	
	
	
	
	
	
	
	
	
    
	
     
	
	
	See:
	
		VertexFormat#position