Commit e7dd8707 authored by Adam Barth's avatar Adam Barth

Improve docs for MediaQueryData.size

This would have answered a question we go on flutter-dev.

Fixes #3517
parent 8ce2f859
...@@ -18,14 +18,24 @@ enum Orientation { ...@@ -18,14 +18,24 @@ enum Orientation {
/// The result of a media query. /// The result of a media query.
class MediaQueryData { class MediaQueryData {
/// Creates data for a media query with explicit values.
///
/// Consider using [MediaQueryData.fromWindow] to create data based on a
/// [ui.Window].
const MediaQueryData({ this.size, this.devicePixelRatio, this.padding }); const MediaQueryData({ this.size, this.devicePixelRatio, this.padding });
/// Creates data for a media query based on the given window.
MediaQueryData.fromWindow(ui.Window window) MediaQueryData.fromWindow(ui.Window window)
: size = window.size, : size = window.size,
devicePixelRatio = window.devicePixelRatio, devicePixelRatio = window.devicePixelRatio,
padding = new EdgeInsets.fromWindowPadding(window.padding); padding = new EdgeInsets.fromWindowPadding(window.padding);
/// The size of the media (e.g, the size of the screen). /// The size of the media in logical pixel (e.g, the size of the screen).
///
/// Logical pixels are roughly the same visual size across devices. Physical
/// pixels are the size of the actual hardware pixels on the device. The
/// number of physical pixels per logical pixel is described by the
/// [devicePixelRatio].
final Size size; final Size size;
/// The number of device pixels for each logical pixel. This number might not /// The number of device pixels for each logical pixel. This number might not
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment