Epok Engine

EPOK RUNTIME

epok::request_scene

Function · 4 overloads

Function

Requests scene as part of the epok module.

Belongs to
epok
Header
epok.hpp
Overloads
4

Declaration 1 of 4

Declaration
bool request_scene(const char* name)

Requests scene as part of the epok module.

ParameterTypeMeaning
nameconst char *Value supplied for name. Keep referenced or pointed-to data valid for the complete call.

Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// const char * name

auto result = epok::request_scene(name);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/epok.hpp:195

Declaration 2 of 4

Declaration
bool request_scene(const char* name,const TransitionOptions& options)

Requests scene as part of the epok module.

ParameterTypeMeaning
nameconst char *Value supplied for name. Keep referenced or pointed-to data valid for the complete call.
optionsconst TransitionOptions &Value supplied for options. Keep referenced or pointed-to data valid for the complete call.

Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// const char * name
// const TransitionOptions & options

auto result = epok::request_scene(name, options);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/epok.hpp:197

Declaration 3 of 4

Declaration
bool request_scene(size_t index)

Requests scene as part of the epok module.

ParameterTypeMeaning
indexsize_tValue supplied for index. Keep referenced or pointed-to data valid for the complete call.

Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// size_t index

auto result = epok::request_scene(index);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations.

Declared in runtime/epok.hpp:194

Declaration 4 of 4

Declaration
bool request_scene(size_t index,const TransitionOptions& options)

Requests scene as part of the epok module.

ParameterTypeMeaning
indexsize_tValue supplied for index. Keep referenced or pointed-to data valid for the complete call.
optionsconst TransitionOptions &Value supplied for options. Keep referenced or pointed-to data valid for the complete call.

Returns: bool. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// size_t index
// const TransitionOptions & options

auto result = epok::request_scene(index, options);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/epok.hpp:196

Related members