Repository: google/filament
File: filament/include/filament/Engine.h (C/C++)

Code before:
     *
     * This value does not apply when using the instances(size_t) method on
     * RenderableManager::Builder.
     *
     * @return the number of max automatic instances
     * @see setAutomaticInstancingEnabled
     * @see RenderableManager::Builder::instances(size_t)
     * @see RenderableManager::Builder::instances(size_t, InstanceBuffer*)
     */
    size_t getMaxAutomaticInstances() const noexcept;

    /**
     * Queries the device and platform for support of the given stereoscopic type.
     *
     * @return true if the given stereo rendering is supported, false otherwise
     * @see View::setStereoscopicOptions
     */
    bool isStereoSupported(StereoscopicType stereoscopicType) const noexcept;

    /**
     * Queries the device and platform for support of asynchronous operation.
     *
     * @param mode The asynchronous mode that the caller wants to check whether to support.
     * @return The mode the engine currently supports. Returns NONE if none of them is supported.
     */
    AsynchronousMode isAsynchronousOperationSupported(AsynchronousMode mode) const noexcept;

    /**
     * Retrieves the configuration settings of this Engine.
     *
     * This method returns the configuration object that was supplied to the Engine's
     * Builder::config method during the creation of this Engine. If the Builder::config method was
     * not explicitly called (or called with nullptr), this method returns the default configuration
     * settings.
     *
     * @return a Config object with this Engine's configuration
     * @see Builder::config
     */
    const Config& getConfig() const noexcept;

    /**
     * Returns the maximum number of stereoscopic eyes supported by Filament. The actual number of
     * eyes rendered is set at Engine creation time with the Engine::Config::stereoscopicEyeCount
     * setting.
     *
     * @return the max number of stereoscopic eyes supported
     * @see Engine::Config::stereoscopicEyeCount
     */
    static size_t getMaxStereoscopicEyes() noexcept;

    /**

Review comment (suggestion):
Maybe this should be renamed to `resolveAsynchronousMode` or something, and the argument can be called `hint`? I expect a method that starts with "is" to return a bool.

Code after:
     *
     * This value does not apply when using the instances(size_t) method on
     * RenderableManager::Builder.
     *
     * @return the number of max automatic instances
     * @see setAutomaticInstancingEnabled
     * @see RenderableManager::Builder::instances(size_t)
     * @see RenderableManager::Builder::instances(size_t, InstanceBuffer*)
     */
    size_t getMaxAutomaticInstances() const noexcept;

    /**
     * Queries the device and platform for support of the given stereoscopic type.
     *
     * @return true if the given stereo rendering is supported, false otherwise
     * @see View::setStereoscopicOptions
     */
    bool isStereoSupported(StereoscopicType stereoscopicType) const noexcept;

    /**
     * Checks if the engine is set up for asynchronous operation. If it returns true, the
     * asynchronous versions of the APIs are available for use.
     *
     * @return true if the engine supports asynchronous operation.
     */
    bool isAsynchronousOperationSupported() const noexcept;

    /**
     * Retrieves the configuration settings of this Engine.
     *
     * This method returns the configuration object that was supplied to the Engine's
     * Builder::config method during the creation of this Engine. If the Builder::config method was
     * not explicitly called (or called with nullptr), this method returns the default configuration
     * settings.
     *
     * @return a Config object with this Engine's configuration
     * @see Builder::config
     */
    const Config& getConfig() const noexcept;

    /**
     * Returns the maximum number of stereoscopic eyes supported by Filament. The actual number of
     * eyes rendered is set at Engine creation time with the Engine::Config::stereoscopicEyeCount
     * setting.
     *
     * @return the max number of stereoscopic eyes supported
     * @see Engine::Config::stereoscopicEyeCount
     */
    static size_t getMaxStereoscopicEyes() noexcept;

    /**