Render Settings

Render Settings

[ needs improvement ]

set_render_engine_to_cycles()

Convenience functions :

• set_render_engine_cycles()

set_render_engine_to_eevee()

Convenience functions :

• set_render_engine_eevee()

render_image(use_view)

Renders the image in current frame

Parameters :

• use_view (Boolean) : If True will render in viewport else in new image editor window. False by default

Returns : Image

render_animation(use_view)

Parameters :

• use_view (boolean) : If True will render in viewport else in new image editor window. False by default

set_render_resolution(x, y)

Set render output's width and height pixels

Parameters :

• x* (int) : Horizontal Pixels
• y* (int) : Vertical Pixels

get_render_resolution()

Get render output's width and height pixels

Returns : List of x and y pixels

render_resolution(x, y)

Get or set render output's width and height pixels.

Parameters :

• x (int) : Horizontal Pixels
• y (int) : Vertical Pixels

Returns : List of x and y pixels | None

set_render_resolution_percentage(percent)

Parameters :

• percent* (int) : Percentage

Convenience functions :

• set_render_percentage(percent)
• set_render_percent(percent)

get_render_resolution_percentage()

Returns : Percentage(0 to 100)

render_resolution_percentage(percent)

A multipurpose function that either sets or gets the render resolution percent depending on if the percent argument is provided

Parameters :

• percent (int) : Percentage

Returns : Percentage(0 to 100)

set_render_pixel_aspect_ratio(x, y)

Parameters :

• x* (float) : Horizontal aspect
• y* (float) : Vertical aspect

get_render_pixel_aspect_ratio()

Returns : List of x and y aspects

render_aspect_ratio(x, y)

A multipurpose function that either sets or gets the render pixel aspect ratio depending on if the x and y arguments are provided.

Parameters :

• x (float) : Horizontal aspect
• y (float) : Vertical aspect

Returns : List of x and y aspects | None

current_frame(val)

A multipurpose function that either sets or gets current frame

Parameters :

• val (int) : Frame number

Returns : Frame no.

Convenience functions :

• set_frame(val)
• set_current_frame(val)

frame_start(val)

A multipurpose function that either sets or gets starting frame

Parameters :

• val (int) : Frame number

Returns : Frame no.

Convenience functions :

• set_frame_start(val)
• set_start_frame(val)

frame_end(val)

A multipurpose function that either sets or gets end frame

Parameters :

• val (int) : Frame number

Returns : Frame no.

Convenience functions :

• set_frame_end(val)
• set_end_frame(val)

set_frame_interval(start, end)

Set both start and end frame

Parameters :

• start (int) : Start frame number
• end (int) : End frame number

set_frame_step(val)

Number of frames to skip forward while rendering/playing back each frame

Parameters :

• val* (int) : Step

set_render_fps(val, base)

Parameters :

• val* (int) : fps
• base (float) : base. 1 by default