WebGLRenderer: animate() → setRenderLoop()?

[mrdoob]

While working on a new WebVR project, it somehow felt that setRenderLoop() would be a better name than animate() but I'm unsure.

var renderer = new THREE.WebGLRenderer();
renderer.setPixelRatio( window.devicePixelRatio );
renderer.setSize( window.innerWidth, window.innerHeight );
renderer.setRenderLoop( render );
document.body.appendChild( renderer.domElement );

function render( timestamp ) {

    renderer.render( scene, camera );

}

Thoughts?

[mkeblx]

Makes sense especially since other methods that 'set' something are set{X} form.

[Usnul]

I think it's not super descriptive. I would call it "simulate" or something along the lines of "addFrameEventHandler"

[looeee]

What about startRenderLoop ? Since we are starting to call render in a loop here I think that's pretty descriptive.

[Usnul]

@looeee
can i do this?

renderer.startRenderLoop( makePancakes );

function makePancakes ( timestamp ) {

    console.log("In a large bowl, sift together the flour, baking powder, salt and sugar. Make a well in the center and pour in the milk, egg and melted butter; mix until smooth.");

    console.log("Heat a lightly oiled griddle or frying pan over medium high heat. Pour or scoop the batter onto the griddle, using approximately 1/4 cup for each pancake. Brown on both sides and serve hot.");

}

is this a good name then? :)

[looeee]

No, but I challenge you to think of a non-stupid, useful example where the callback function being passed WebGLRenderer.animate should be called something other than render. 😛
If you can then I'll change my mind.

[Usnul]

Challenge accepted! There are typically multiple simulation systems involved in making an interactive application such as a game. One obvious example is physics simulation. If you go by a ECS paradigm (entity component system) - every system can benefit from an update step. Most of these systems are typically non-visual.

[looeee]

OK, that's a good point. Consider me convinced 😄

A typical (simplified) Game loop at looks like:

while( true ) {
    getUserInput()
    update()   // update physics, animation and anything else
    render()  // draw 
}

Obviously the getUserInput is handled differently in JS due to eventListeners, but otherwise it's similar to a typical three.js loop with the while replaced by RAF. So I don't think that the animate function should have Render in the name.

How about startRAFLoop ?

[mrdoob]

What about startRenderLoop ? Since we are starting to call render in a loop here I think that's pretty descriptive.

Hmm, I like that one too...

[mrdoob]

How about startRAFLoop ?

startAnimationLoop may sound less alien.

[fernandojsg]

+1 for the startAnimationLoop I agree with @Usnul that renderloop is misleading. (Although I'm not a big fan of animationloop either, but well it's still better than the other alternatives :D)

[Makio64]

If its a RAF call, then I think it should be a clear in the name :
.onEveryFrame( callback )
.onRAF( callback )

But I don't understand why there is this function on a WebglRenderer ?

[mrdoob]

But I don't understand why there is this function on a WebglRenderer ?

Because the WebVR API has its own requestAnimationFrame and renders black if you use window.requestAnimationFrame.

[Makio64]

I see, then for peoples who doesnt know it like me, maybe it'll be worth it to made it more obvious :
.onWebVRAnimationFrame( callback )
.onWebVRFrame( callback )