How can I do a render of the 3D Viewport, in Python, so it uses the shading style I've selected?

Question

I've found that I can't change the normal rendering, from a camera, to WIREFRAME, SOLID, or anything but RENDERED. (Actually, there isn't a setting to change, it just goes to RENDERED.) In the Python Console,I've done this:

First, I set a variable to the area that is the 3D Viewport for convenience. Then I check the shading and it's WIREFRAME. From there, I render that space, the 3D Viewport. It always renders from the default camera. My first test render rendered in the SOLID mode, but now I can't get it to render the 3D Viewport view (using bpy.ops.render.opengl()) and it always renders in RENDERED mode. Here's a sample - rather crowded and from the top:

I was under the impression that if I rendered the 3D Viewport space, I could get it to render in whatever shading method that was currently set for the Viewport. Is that not the case? Other than using plugins, is there a way to control the shading for rendering the view in the Viewport?

I'm beginning to think it just won't work, but I thought I saw instructions (that worked) that would let me do this and I've been searching, but can't find a way to do it.

So, bottom line, how can I specify the shading mode in the Viewport, render that view, then save the file?

Answer 1

The render.opengl() operator is working fine for all modes. But notice that it takes a screenshot of the first viewport found, quoting the docs: "Take a snapshot of the active viewport". So in case you have multiple 3d viewports open at the same time it takes the first one in the area list of your screen (Screen.Areas).

---

Obviously the simplest option is to close all 3d viewports except one, set the shading mode, call the operator and pass write_still=True to take the screenshot as well as saving the file into the default Output directory:

>>> bpy.ops.render.opengl(write_still=True)

In case you have multiple viewports open and you'd like to specify the area for the screenshot, you can override the context when calling render.opengl() operator. See the following demo on how to find the first 3d viewport set to 'WIREFRAME' and take a screenshot:

import bpy

C = bpy.context

for area in C.screen.areas:
    if area.type=='VIEW_3D':
        # Check for WIREFRAME, SOLID, RENDERED, MATERIAL
        # area.spaces.active.shading.type
        if area.spaces.active.shading.type == 'WIREFRAME':
            override = C.copy()
            override['area'] = area
            bpy.ops.render.opengl(override)
            break

In order to set the filename, just temporary assign your path to the RenderSettings.filepath property. Demo on how to take a screenshot of the first viewport found set to 'WIREFRAME' and save the result to the directory of the current blend file:

file_path = bpy.path.abspath("//screenshot")

for area in C.screen.areas:
    if area.type=='VIEW_3D':
        if area.spaces.active.shading.type == 'WIREFRAME':
            # Store the current output path and set it
            temp = C.scene.render.filepath
            C.scene.render.filepath = file_path
            
            override = C.copy()
            override['area'] = area
            bpy.ops.render.opengl(override, write_still=True)
            
            # Restore the output path
            C.scene.render.filepath = temp
            break
            
print (file_path)

3.2 Update

Context overrides are deprecated in Blender 3.2 and are scheduled to be removed in Blender 3.3 The replacement is temp_override. The manual has examples of how to use the new function.