UserPreferencesSystem(bpy_struct)

base class — bpy_struct

class bpy.types.UserPreferencesSystem(bpy_struct)

Graphics driver and operating system settings

anisotropic_filter

Quality of the anisotropic filtering (values greater than 1.0 enable anisotropic filtering)

Type:enum in [‘FILTER_0’, ‘FILTER_2’, ‘FILTER_4’, ‘FILTER_8’, ‘FILTER_16’], default ‘FILTER_0’
audio_channels

Audio channel count

  • MONO Mono, Set audio channels to mono.
  • STEREO Stereo, Set audio channels to stereo.
  • SURROUND4 4 Channels, Set audio channels to 4 channels.
  • SURROUND51 5.1 Surround, Set audio channels to 5.1 surround sound.
  • SURROUND71 7.1 Surround, Set audio channels to 7.1 surround sound.
Type:enum in [‘MONO’, ‘STEREO’, ‘SURROUND4’, ‘SURROUND51’, ‘SURROUND71’], default ‘MONO’
audio_device

Audio output device

  • NONE None, Null device - there will be no audio output.
  • SDL SDL, SDL device - simple direct media layer, recommended for sequencer usage.
  • OPENAL OpenAL, OpenAL device - supports 3D audio, recommended for game engine usage.
  • JACK Jack, JACK - Audio Connection Kit, recommended for pro audio users.
Type:enum in [‘NONE’, ‘SDL’, ‘OPENAL’, ‘JACK’], default ‘NONE’
audio_mixing_buffer

Number of samples used by the audio mixing buffer

  • SAMPLES_256 256, Set audio mixing buffer size to 256 samples.
  • SAMPLES_512 512, Set audio mixing buffer size to 512 samples.
  • SAMPLES_1024 1024, Set audio mixing buffer size to 1024 samples.
  • SAMPLES_2048 2048, Set audio mixing buffer size to 2048 samples.
  • SAMPLES_4096 4096, Set audio mixing buffer size to 4096 samples.
  • SAMPLES_8192 8192, Set audio mixing buffer size to 8192 samples.
  • SAMPLES_16384 16384, Set audio mixing buffer size to 16384 samples.
  • SAMPLES_32768 32768, Set audio mixing buffer size to 32768 samples.
Type:enum in [‘SAMPLES_256’, ‘SAMPLES_512’, ‘SAMPLES_1024’, ‘SAMPLES_2048’, ‘SAMPLES_4096’, ‘SAMPLES_8192’, ‘SAMPLES_16384’, ‘SAMPLES_32768’], default ‘SAMPLES_256’
audio_sample_format

Audio sample format

  • U8 8-bit Unsigned, Set audio sample format to 8 bit unsigned integer.
  • S16 16-bit Signed, Set audio sample format to 16 bit signed integer.
  • S24 24-bit Signed, Set audio sample format to 24 bit signed integer.
  • S32 32-bit Signed, Set audio sample format to 32 bit signed integer.
  • FLOAT 32-bit Float, Set audio sample format to 32 bit float.
  • DOUBLE 64-bit Float, Set audio sample format to 64 bit float.
Type:enum in [‘U8’, ‘S16’, ‘S24’, ‘S32’, ‘FLOAT’, ‘DOUBLE’], default ‘U8’
audio_sample_rate

Audio sample rate

  • RATE_44100 44.1 kHz, Set audio sampling rate to 44100 samples per second.
  • RATE_48000 48 kHz, Set audio sampling rate to 48000 samples per second.
  • RATE_96000 96 kHz, Set audio sampling rate to 96000 samples per second.
  • RATE_192000 192 kHz, Set audio sampling rate to 192000 samples per second.
Type:enum in [‘RATE_44100’, ‘RATE_48000’, ‘RATE_96000’, ‘RATE_192000’], default ‘RATE_44100’
author

Name that will be used in exported files when format supports such feature

Type:string, default “”, (never None)
color_picker_type

Different styles of displaying the color picker widget

  • CIRCLE_HSV Circle (HSV), A circular Hue/Saturation color wheel, with Value slider.
  • CIRCLE_HSL Circle (HSL), A circular Hue/Saturation color wheel, with Lightness slider.
  • SQUARE_SV Square (SV + H), A square showing Saturation/Value, with Hue slider.
  • SQUARE_HS Square (HS + V), A square showing Hue/Saturation, with Value slider.
  • SQUARE_HV Square (HV + S), A square showing Hue/Value, with Saturation slider.
Type:enum in [‘CIRCLE_HSV’, ‘CIRCLE_HSL’, ‘SQUARE_SV’, ‘SQUARE_HS’, ‘SQUARE_HV’], default ‘CIRCLE_HSV’
compute_device

Device to use for computation

Type:enum in [‘CPU’], default ‘CPU’
compute_device_type

Device to use for computation (rendering with Cycles)

  • NONE None, Don’t use compute device.
Type:enum in [‘NONE’], default ‘NONE’
dpi

Font size and resolution for display

Type:int in [48, 144], default 0
font_path_ui

Path to interface font

Type:string, default “”, (never None)
font_path_ui_mono

Path to interface mono-space Font

Type:string, default “”, (never None)
frame_server_port

Frameserver Port for Frameserver Rendering

Type:int in [0, 32727], default 0
gl_clip_alpha

Clip alpha below this threshold in the 3D textured view

Type:float in [0, 1], default 0.0
gl_texture_limit

Limit the texture size to save graphics memory

Type:enum in [‘CLAMP_OFF’, ‘CLAMP_8192’, ‘CLAMP_4096’, ‘CLAMP_2048’, ‘CLAMP_1024’, ‘CLAMP_512’, ‘CLAMP_256’, ‘CLAMP_128’], default ‘CLAMP_OFF’
image_draw_method

Method used for displaying images on the screen

  • 2DTEXTURE 2D Texture, Use CPU for display transform and draw image with 2D texture.
  • GLSL GLSL, Use GLSL shaders for display transform and draw image with 2D texture.
  • DRAWPIXELS DrawPixels, Use CPU for display transform and draw image using DrawPixels.
Type:enum in [‘2DTEXTURE’, ‘GLSL’, ‘DRAWPIXELS’], default ‘2DTEXTURE’
memory_cache_limit

Memory cache limit (in megabytes)

Type:int in [0, 32768], default 0
multi_sample

Enable OpenGL multi-sampling, only for systems that support it, requires restart

  • NONE No MultiSample, Do not use OpenGL MultiSample.
  • 2 MultiSample: 2, Use 2x OpenGL MultiSample (requires restart).
  • 4 MultiSample: 4, Use 4x OpenGL MultiSample (requires restart).
  • 8 MultiSample: 8, Use 8x OpenGL MultiSample (requires restart).
  • 16 MultiSample: 16, Use 16x OpenGL MultiSample (requires restart).
Type:enum in [‘NONE’, ‘2’, ‘4’, ‘8’, ‘16’], default ‘NONE’
opensubdiv_compute_type

Type of computer back-end used with OpenSubdiv

Type:enum in [‘NONE’], default ‘NONE’
pixel_size
Type:float in [-inf, inf], default 0.0, (readonly)
prefetch_frames

Number of frames to render ahead during playback (sequencer only)

Type:int in [0, inf], default 0
screencast_fps

Frame rate for the screencast to be played back

Type:int in [10, 100], default 0
screencast_wait_time

Time in milliseconds between each frame recorded for screencast

Type:int in [10, 1000], default 0
scrollback

Maximum number of lines to store for the console buffer

Type:int in [32, 32768], default 0
select_method

Use OpenGL occlusion queries or selection render mode to accelerate selection

Type:enum in [‘AUTO’, ‘GL_SELECT’, ‘GL_QUERY’], default ‘AUTO’
solid_lights

Lights user to display objects in solid draw mode

Type:bpy_prop_collection of UserSolidLight, (readonly)
texture_collection_rate

Number of seconds between each run of the GL texture garbage collector

Type:int in [1, 3600], default 0
texture_time_out

Time since last access of a GL texture in seconds after which it is freed (set to 0 to keep textures allocated)

Type:int in [0, 3600], default 0
use_16bit_textures

Use 16 bit per component texture for float images

Type:boolean, default False
use_gpu_mipmap

Generate Image Mipmaps on the GPU

Type:boolean, default False
use_international_fonts

Use international fonts

Type:boolean, default False
use_mipmaps

Scale textures for the 3D View (looks nicer but uses more memory and slows image reloading)

Type:boolean, default False
use_preview_images

Allow user to choose any codec (Windows only, might generate instability)

Type:boolean, default False
use_region_overlap

Draw tool/property regions over the main region, when using Triple Buffer

Type:boolean, default False
use_scripts_auto_execute

Allow any .blend file to run scripts automatically (unsafe with blend files from an untrusted source)

Type:boolean, default False
use_tabs_as_spaces

Automatically convert all new tabs into spaces for new and loaded text files

Type:boolean, default False
use_text_antialiasing

Draw user interface text anti-aliased

Type:boolean, default False
use_textured_fonts

Use textures for drawing international fonts

Type:boolean, default False
use_translate_interface

Translate interface

Type:boolean, default False
use_translate_new_dataname

Translate new data names (when adding/creating some)

Type:boolean, default False
use_translate_tooltips

Translate tooltips

Type:boolean, default False
use_weight_color_range

Enable color range used for weight visualization in weight painting mode

Type:boolean, default False
virtual_pixel_mode

Modify the pixel size for hi-res devices

  • NATIVE Native, Use native pixel size of the display.
  • DOUBLE Double, Use double the native pixel size of the display.
Type:enum in [‘NATIVE’, ‘DOUBLE’], default ‘NATIVE’
weight_color_range

Color range used for weight visualization in weight painting mode

Type:ColorRamp, (readonly, never None)
window_draw_method

Drawing method used by the window manager

  • AUTOMATIC Automatic, Automatically set based on graphics card and driver.
  • TRIPLE_BUFFER Triple Buffer, Use a third buffer for minimal redraws at the cost of more memory.
  • OVERLAP Overlap, Redraw all overlapping regions, minimal memory usage but more redraws.
  • OVERLAP_FLIP Overlap Flip, Redraw all overlapping regions, minimal memory usage but more redraws (for graphics drivers that do flipping).
  • FULL Full, Do a full redraw each time, slow, only use for reference or when everything else fails.
Type:enum in [‘AUTOMATIC’, ‘TRIPLE_BUFFER’, ‘OVERLAP’, ‘OVERLAP_FLIP’, ‘FULL’], default ‘TRIPLE_BUFFER’

Inherited Properties

Inherited Functions

References