ResourceInteractiveLoader¶
Category: Core
Methods¶
Resource | get_resource ( ) |
int | get_stage ( ) const |
int | get_stage_count ( ) const |
Error | poll ( ) |
Error | wait ( ) |
Description¶
Interactive Resource loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying loading bars/percentages.
Method Descriptions¶
- Resource get_resource ( )
Returns the loaded resource if the load operation completed successfully, null
otherwise.
- int get_stage ( ) const
Returns the load stage. The total amount of stages can be queried with get_stage_count.
- int get_stage_count ( ) const
Returns the total amount of stages (calls to poll) needed to completely load this resource.
- Error poll ( )
Polls the loading operation, i.e. loads a data chunk up to the next stage.
Returns @GlobalScope.OK if the poll is successful but the load operation has not finished yet (intermediate stage). This means poll will have to be called again until the last stage is completed.
Returns @GlobalScope.ERR_FILE_EOF if the load operation has completed successfully. The loaded resource can be obtained by calling get_resource.
Returns another Error code if the poll has failed.
- Error wait ( )
Polls the loading operation successively until the resource is completely loaded or a poll fails.
Returns @GlobalScope.ERR_FILE_EOF if the load operation has completed successfully. The loaded resource can be obtained by calling get_resource.
Returns another Error code if a poll has failed, aborting the operation.